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

S

satisfies(Consumer<D>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Entity

Verify the entity with the given Consumer.

satisfy(Consumer<List<ResponseError>>) - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Errors

Inspect errors in the response, if any.

saveInstance(ContextSnapshotFactory, GraphQLContext) - Static method in class org.springframework.graphql.execution.ContextSnapshotFactoryHelper

Save the ContextSnapshotFactory in the given Context.

saveInstance(ContextSnapshotFactory, Context) - Static method in class org.springframework.graphql.execution.ContextSnapshotFactoryHelper

Save the ContextSnapshotFactory in the given Context.

scheduler(Scheduler) - Method in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder

scheduler(Scheduler) - Method in interface org.springframework.graphql.client.GraphQlClient.SyncBuilder

The scheduler to use for non-blocking execution with GraphQlClient.RequestSpec.execute() and GraphQlClient.RequestSpec.retrieve(String).

schema() - Method in interface org.springframework.graphql.execution.GraphQlSource

Return the GraphQLSchema used by the current GraphQL.

schema() - Method in interface org.springframework.graphql.execution.SchemaReport

Return the inspected schema with type and field definitions.

schemaFactory(BiFunction<TypeDefinitionRegistry, RuntimeWiring, GraphQLSchema>) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder

Configure a function to create the GraphQLSchema from the given TypeDefinitionRegistry and RuntimeWiring.

SchemaHandler - Class in org.springframework.graphql.server.webflux

Spring WebFlux functional handler that renders the GraphQLSchema printed via SchemaPrinter.

SchemaHandler - Class in org.springframework.graphql.server.webmvc

Spring MVC functional handler that renders the GraphQLSchema printed via SchemaPrinter.

SchemaHandler(GraphQlSource) - Constructor for class org.springframework.graphql.server.webflux.SchemaHandler

SchemaHandler(GraphQlSource) - Constructor for class org.springframework.graphql.server.webmvc.SchemaHandler

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

Annotation to express the mapping of a handler method to a GraphQL type and field pair.

SchemaMappingInspector - Class in org.springframework.graphql.execution

Inspect schema mappings on startup to ensure the following: Schema fields have either a DataFetcher registration or a corresponding Class property.

SchemaMappingInspector.ClassResolver - Interface in org.springframework.graphql.execution

Strategy to resolve the Java class(es) for a GraphQLObjectType, effectively the reverse of TypeResolver, for schema inspection purposes.

SchemaMappingInspector.Initializer - Interface in org.springframework.graphql.execution

Helps to configure SchemaMappingInspector.

SchemaReport - Interface in org.springframework.graphql.execution

Report produced as a result of inspecting schema mappings.

SchemaReport.SkippedType - Interface in org.springframework.graphql.execution

Information about a schema type skipped during the inspection.

schemaResourceBuilder() - Static method in interface org.springframework.graphql.execution.GraphQlSource

Return a GraphQlSource builder that parses GraphQL Schema resources and uses RuntimeWiring to create the GraphQLSchema.

schemaResources(Resource...) - Method in interface org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder

Add schema definition resources, typically ".graphqls" files, to be parsed and merged.

scrollable() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder

Build a DataFetcher that scrolls and returns Window.

scrollable() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder

Build a DataFetcher that scrolls and returns Window.

scrollable() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder

Build a DataFetcher that scrolls and returns Window.

scrollable() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder

Build a DataFetcher that scrolls and returns Window.

ScrollPositionCursorStrategy - Class in org.springframework.graphql.data.query

Strategy to convert a ScrollPosition to and from a String cursor.

ScrollPositionCursorStrategy() - Constructor for class org.springframework.graphql.data.query.ScrollPositionCursorStrategy

Shortcut constructor that uses JsonKeysetCursorStrategy.

ScrollPositionCursorStrategy(CursorStrategy<Map<String, Object>>) - Constructor for class org.springframework.graphql.data.query.ScrollPositionCursorStrategy

Constructor with a given strategy to convert a keyset to and from a cursor.

ScrollSubrange - Class in org.springframework.graphql.data.query

Subrange implementation for a ScrollPosition cursor.

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

A SubrangeMethodArgumentResolver that supports ScrollSubrange and ScrollPosition as cursor.

ScrollSubrangeMethodArgumentResolver(CursorStrategy<ScrollPosition>) - Constructor for class org.springframework.graphql.data.method.annotation.support.ScrollSubrangeMethodArgumentResolver

SecurityContextThreadLocalAccessor - Class in org.springframework.graphql.execution

ThreadLocalAccessor to extract and restore security context through SecurityContextHolder.

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

SecurityDataFetcherExceptionResolver - Class in org.springframework.graphql.execution

DataFetcherExceptionResolver for Spring Security exceptions.

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

selectInstance(ContextSnapshotFactory) - Static method in class org.springframework.graphql.execution.ContextSnapshotFactoryHelper

Select a ContextSnapshotFactory instance to use, either the one passed in if it is not null, or a shared, static instance.

SelfDescribingDataFetcher<T> - Interface in org.springframework.graphql.execution

Specialized DataFetcher that exposes additional details such as return type information.

SerializableGraphQlRequest - Class in org.springframework.graphql.server.support

GraphQlRequest for deserialization from a request.

SerializableGraphQlRequest() - Constructor for class org.springframework.graphql.server.support.SerializableGraphQlRequest

setApplicationContext(ApplicationContext) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport

setAuthenticationTrustResolver(AuthenticationTrustResolver) - Method in class org.springframework.graphql.execution.ReactiveSecurityDataFetcherExceptionResolver

Set the resolver to use to check if an authentication is anonymous that in turn determines whether AccessDeniedException is classified as "unauthorized" or "forbidden".

setAuthenticationTrustResolver(AuthenticationTrustResolver) - Method in class org.springframework.graphql.execution.SecurityDataFetcherExceptionResolver

Set the resolver to use to check if an authentication is anonymous that in turn determines whether AccessDeniedException is classified as "unauthorized" or "forbidden".

setBlockingMethodPredicate(Predicate<HandlerMethod>) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport

Configure a predicate to decide which controller methods are blocking.

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

Enable or disable caching of resolved documents.

setClassNameExtractor(Function<Class<?>, String>) - Method in class org.springframework.graphql.execution.ClassNameTypeResolver

Customize how the name of a class, or a base class/interface, is determined.

setDataBinderInitializer(Consumer<DataBinder>) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer

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

this property is deprecated, ignored, and should not be necessary as a DataBinder is no longer used to bind arguments

setExecutionResult(ExecutionResult) - Method in class org.springframework.graphql.observation.ExecutionRequestObservationContext

Set the result for the request execution.

setExecutor(Executor) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport

Configure an Executor to use for asynchronous handling of Callable return values from controller methods, as well as for blocking controller methods on Java 21+.

setExtensions(Map<String, Object>) - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest

setFallBackOnDirectFieldAccess(boolean) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport

Whether binding GraphQL arguments onto @Argument should falls back to direct field access in case the target object does not use accessor methods.

setId(String) - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage

setJsonCodecs(Encoder<?>, Decoder<?>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder

Transport-specific subclasses can provide their JSON Encoder and Decoder for use at the client level, for mapping response data to some target entity type.

setJsonConverter(HttpMessageConverter<Object>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientSyncBuilder

Transport-specific subclasses can provide their JSON Encoder and Decoder for use at the client level, for mapping response data to some target entity type.

setJsonDecoder(Decoder<?>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder

Variant of AbstractGraphQlClientBuilder.setJsonCodecs(org.springframework.core.codec.Encoder<?>, org.springframework.core.codec.Decoder<?>) for setting each codec individually.

setJsonEncoder(Encoder<?>) - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder

Variant of AbstractGraphQlClientBuilder.setJsonCodecs(org.springframework.core.codec.Encoder<?>, org.springframework.core.codec.Decoder<?>) for setting each codec individually.

setOperationName(String) - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest

setPayload(Object) - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage

setQuery(String) - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest

setThreadLocalContextAware(boolean) - Method in class org.springframework.graphql.execution.DataFetcherExceptionResolverAdapter

Subclasses can set this to indicate that ThreadLocal context from the transport handler (e.g.

setThreadLocalContextAware(boolean) - Method in class org.springframework.graphql.execution.SubscriptionExceptionResolverAdapter

Subclasses can set this to indicate that ThreadLocal context from the transport handler (e.g.

setType(String) - Method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage

setTypeDefinitionRegistry(TypeDefinitionRegistry) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerConfigurer

setTypeDefinitionRegistry(TypeDefinitionRegistry) - Method in interface org.springframework.graphql.execution.RuntimeWiringConfigurer

Provides the configurer access to the TypeDefinitionRegistry.

setTypeResolver(TypeResolver) - Method in class org.springframework.graphql.data.federation.FederationSchemaFactory

Configure a resolver that helps to map Java to entity schema type names.

setValue() - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor

setValue(Object) - Method in class org.springframework.graphql.execution.SecurityContextThreadLocalAccessor

setVariables(Map<String, Object>) - Method in class org.springframework.graphql.server.support.SerializableGraphQlRequest

shouldInvokeAsync(HandlerMethod) - Method in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport

single() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder

Build a DataFetcher to fetch single object instances.

single() - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder

Build a DataFetcher to fetch single object instances.

single() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder

Build a DataFetcher to fetch single object instances.

single() - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder

Build a DataFetcher to fetch single object instances}.

skippedTypes() - Method in interface org.springframework.graphql.execution.SchemaReport

Return types skipped during the inspection, either because the schema type is not supported, e.g.

SliceConnectionAdapter - Class in org.springframework.graphql.data.query

Adapter for Slice to Connection.

SliceConnectionAdapter(CursorStrategy<ScrollPosition>) - Constructor for class org.springframework.graphql.data.query.SliceConnectionAdapter

Constructor with the CursorStrategy to use to encode the ScrollPosition of page items.

sortBy(Sort) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.Builder

Apply a Sort order.

sortBy(Sort) - Method in class org.springframework.graphql.data.query.QueryByExampleDataFetcher.ReactiveBuilder

Apply a Sort order.

sortBy(Sort) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.Builder

Apply a Sort order.

sortBy(Sort) - Method in class org.springframework.graphql.data.query.QuerydslDataFetcher.ReactiveBuilder

Apply a Sort order.

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

Resolver for method arguments of type Sort.

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

SortStrategy - Interface in org.springframework.graphql.data.query

Strategy to extract Sort details from GraphQL arguments.

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

Resolver for the source/parent of a field, obtained via DataFetchingEnvironment.getSource().

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

springSecurityPresent - Static variable in class org.springframework.graphql.data.method.annotation.support.AnnotatedControllerDetectionSupport

start() - Method in interface org.springframework.graphql.client.RSocketGraphQlClient

Start the RSocket session.

start() - Method in interface org.springframework.graphql.client.WebSocketGraphQlClient

Start the GraphQL session by connecting the WebSocket, sending the "connection_init" and receiving the "connection_ack" message.

start() - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester

Start the RSocket session.

start() - Method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester

This is delegated to the start() method of the underlying WebSocketGraphQlClient.

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.

stop() - Method in interface org.springframework.graphql.test.tester.RSocketGraphQlTester

Stop the RSocket session.

stop() - Method in interface org.springframework.graphql.test.tester.WebSocketGraphQlTester

This is delegated to the stop() method of the underlying WebSocketGraphQlClient.

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

Container for parameters that limit result elements to a subrange including a relative position, number of elements, and direction.

Subrange(P, Integer, boolean) - Constructor for class org.springframework.graphql.data.pagination.Subrange

Constructor with the relative position, count, and direction.

SubrangeMethodArgumentResolver<P> - Class in org.springframework.graphql.data.method.annotation.support

Resolver for a method argument of type Subrange initialized from "first", "last", "before", and "after" GraphQL arguments.

SubrangeMethodArgumentResolver(CursorStrategy<P>) - Constructor for class org.springframework.graphql.data.method.annotation.support.SubrangeMethodArgumentResolver

subscribe(String, GraphQlRequest) - Static method in class org.springframework.graphql.server.support.GraphQlWebSocketMessage

Create a "subscribe" client message.

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

Requests an operation specified in the message payload.

SubscriptionErrorException - Exception in org.springframework.graphql.client

WebSocket GraphQlTransportException raised when a subscription ends with an "error" message.

SubscriptionErrorException(GraphQlRequest, List<ResponseError>) - Constructor for exception org.springframework.graphql.client.SubscriptionErrorException

Constructor with the request details and the errors listed in the payload of the "errors" message.

SubscriptionExceptionResolver - Interface in org.springframework.graphql.execution

Contract for a component that is invoked when a GraphQL subscription Publisher ends with an error.

SubscriptionExceptionResolverAdapter - Class in org.springframework.graphql.execution

Adapter for SubscriptionExceptionResolver that pre-implements the asynchronous contract and exposes the following synchronous protected methods: SubscriptionExceptionResolverAdapter.resolveToSingleError(java.lang.Throwable) SubscriptionExceptionResolverAdapter.resolveToMultipleErrors(java.lang.Throwable)

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

subscriptionExceptionResolvers(List<SubscriptionExceptionResolver>) - Method in class org.springframework.graphql.execution.AbstractGraphQlSourceBuilder

subscriptionExceptionResolvers(List<SubscriptionExceptionResolver>) - Method in interface org.springframework.graphql.execution.GraphQlSource.Builder

Add SubscriptionExceptionResolvers that are invoked when a GraphQL subscription Publisher ends with error, and given a chance to resolve the exception to one or more GraphQL errors to be sent to the client.

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

@SubscriptionMapping is a composed annotation that acts as a shortcut for @SchemaMapping with typeName="Subscription".

SubscriptionPublisherException - Exception in org.springframework.graphql.execution

An exception raised after a GraphQL subscription Publisher ends with an exception, and after that exception has been resolved to GraphQL errors.

SubscriptionPublisherException(List<GraphQLError>, Throwable) - Constructor for exception org.springframework.graphql.execution.SubscriptionPublisherException

Constructor with the resolved GraphQL errors and the original exception from the GraphQL subscription Publisher.

supports(Class<?>) - Method in interface org.springframework.graphql.data.pagination.ConnectionAdapter

Whether the adapter supports the given Object container type.

supports(Class<?>) - Method in interface org.springframework.graphql.data.pagination.CursorStrategy

Whether the strategy supports the given type of position Object.

supports(Class<?>) - Method in class org.springframework.graphql.data.pagination.EncodingCursorStrategy

supports(Class<?>) - Method in class org.springframework.graphql.data.query.JsonKeysetCursorStrategy

supports(Class<?>) - Method in class org.springframework.graphql.data.query.ScrollPositionCursorStrategy

supports(Class<?>) - Method in class org.springframework.graphql.data.query.SliceConnectionAdapter

supports(Class<?>) - Method in class org.springframework.graphql.data.query.WindowConnectionAdapter

supportsContext(Observation.Context) - Method in interface org.springframework.graphql.observation.DataFetcherObservationConvention

supportsContext(Observation.Context) - Method in interface org.springframework.graphql.observation.ExecutionRequestObservationConvention

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ArgumentsMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.AuthenticationPrincipalArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ContextValueMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ContinuationHandlerMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.DataFetchingEnvironmentMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.DataLoaderMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.LocalContextValueMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.PrincipalMethodArgumentResolver

Return "true" if the argument is Principal or a subtype.

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ProjectedPayloadMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.ScrollSubrangeMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.SortMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.SourceMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.annotation.support.SubrangeMethodArgumentResolver

supportsParameter(MethodParameter) - Method in interface org.springframework.graphql.data.method.HandlerMethodArgumentResolver

Whether this resolver supports the given MethodParameter.

supportsParameter(MethodParameter) - Method in class org.springframework.graphql.data.method.HandlerMethodArgumentResolverComposite

Whether the given method parameter is supported by any registered HandlerMethodArgumentResolver.

SyncGraphQlClientInterceptor - Interface in org.springframework.graphql.client

Interceptor of GraphQlClient requests for use in a blocking execution chain with a SyncGraphQlTransport.

SyncGraphQlClientInterceptor.Chain - Interface in org.springframework.graphql.client

Contract to delegate to the rest of a blocking execution chain.

SyncGraphQlTransport - Interface in org.springframework.graphql.client

Contract for blocking execution of GraphQL requests over some transport.

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