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|Serialized Form

G

get() - Method in interface org.springframework.graphql.test.tester.GraphQlTester.Entity

Return the decoded entity value(s).

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 class org.springframework.graphql.server.WebGraphQlRequest

Return the request or WebSocket session attributes.

getAttributes() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo

Return the map with attributes associated with the WebSocket session.

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

Return the bean for this handler method.

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

This method returns the type of the handler for this handler method.

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

If the bean method is a bridge method, this method returns the bridged (user-defined) method.

getBuilderInitializer() - Method in class org.springframework.graphql.client.AbstractGraphQlClientBuilder

Return a Consumer to initialize new builders from "this" builder.

getBuilderInitializer() - Method in class org.springframework.graphql.test.tester.AbstractGraphQlTesterBuilder

Subclasses call this from GraphQlTester.Builder.build() to obtain a Consumer to initialize new builder instances with, based on "this" builder.

getCloseStatus() - Method in exception org.springframework.graphql.client.WebSocketDisconnectedException

Return the CloseStatus used to close the WebSocket session.

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

getContent(Object) - Method in interface org.springframework.graphql.data.pagination.ConnectionAdapter

Return the contained items as a List.

getContent(Object) - Method in class org.springframework.graphql.data.query.SliceConnectionAdapter

getContent(Object) - Method in class org.springframework.graphql.data.query.WindowConnectionAdapter

getContextualName(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention

getContextualName(ExecutionRequestObservationContext) - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention

getCookies() - Method in class org.springframework.graphql.server.WebGraphQlRequest

Return the cookies of the request of WebSocket handshake.

getCursorStrategy() - Method in class org.springframework.graphql.data.pagination.ConnectionAdapterSupport

Return the configured CursorStrategy.

getData() - Method in interface org.springframework.graphql.GraphQlResponse

Return the data part of the response, or null when the response is not valid.

getData() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse

getDelegate() - Method in class org.springframework.graphql.data.pagination.EncodingCursorStrategy

Return the decorated CursorStrategy.

getDirection(DataFetchingEnvironment) - Method in class org.springframework.graphql.data.query.AbstractSortStrategy

Return the sort direction to use, or null.

getDocument() - Method in interface org.springframework.graphql.GraphQlRequest

Return the GraphQL document which is the textual representation of an operation (or operations) to perform, including any selection sets and fragments.

getDocument() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest

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

getDocument(String) - Method in interface org.springframework.graphql.support.DocumentSource

Return the document that matches the given name.

getDocument(String) - Method in class org.springframework.graphql.support.ResourceDocumentSource

getEncoder() - Method in class org.springframework.graphql.data.pagination.EncodingCursorStrategy

Return the configured CursorEncoder.

getEnvironment() - Method in class org.springframework.graphql.observation.DataFetcherObservationContext

Return the data fetching environment provided as an input.

getError() - Method in interface org.springframework.graphql.ResponseField

Deprecated.

since 1.0.3 in favor of ResponseField.getErrors()

getErrors() - Method in exception org.springframework.graphql.client.SubscriptionErrorException

Return the errors contained in the GraphQL over WebSocket "errors" message.

getErrors() - Method in exception org.springframework.graphql.execution.SubscriptionPublisherException

Return the GraphQL errors the exception was resolved to by the configured SubscriptionExceptionResolver's.

getErrors() - Method in interface org.springframework.graphql.GraphQlResponse

Return errors included in the response.

getErrors() - Method in interface org.springframework.graphql.ResponseField

Return all errors that have a path, and it is at above, or below the field path.

getErrors() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse

getErrorType() - Method in interface org.springframework.graphql.ResponseError

Return a classification for the error that is specific to GraphQL Java.

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

Return a DataFetcherExceptionResolver that resolves exceptions with @GraphQlExceptionHandler methods in @ControllerAdvice classes declared in Spring configuration.

getExecutionId() - Method in interface org.springframework.graphql.ExecutionGraphQlRequest

Return the configured executionId.

getExecutionId() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest

getExecutionInput() - Method in interface org.springframework.graphql.ExecutionGraphQlResponse

Return the ExecutionInput that was prepared through the ExecutionGraphQlRequest and passed to GraphQL.

getExecutionInput() - Method in class org.springframework.graphql.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.

getHighCardinalityKeyValues(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention

getHighCardinalityKeyValues(ExecutionRequestObservationContext) - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention

getId() - Method in interface org.springframework.graphql.ExecutionGraphQlRequest

Return the transport assigned id for the request that in turn sets executionId.

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

Return the request id that is applicable to messages associated with a request, or null for connection level messages.

getId() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo

Return the id for the WebSocketSession.

getId() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest

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.

getLowCardinalityKeyValues(DataFetcherObservationContext) - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention

getLowCardinalityKeyValues(ExecutionRequestObservationContext) - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention

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.

getName() - Method in class org.springframework.graphql.observation.DefaultDataFetcherObservationConvention

getName() - Method in class org.springframework.graphql.observation.DefaultExecutionRequestObservationConvention

getOperationName() - Method in interface org.springframework.graphql.GraphQlRequest

Return the name of the operation in the document to execute, if the document contains multiple operations.

getOperationName() - Method in class org.springframework.graphql.support.DefaultGraphQlRequest

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

getParsedPath() - Method in interface org.springframework.graphql.ResponseError

Return the path to a response field which experienced the error, if the error can be associated to a particular field in the result, or otherwise an empty list.

getParsedPath() - Method in interface org.springframework.graphql.ResponseField

Return a parsed representation of the field path, in the format described for error paths in Section 7.1.2, "Response Format" of the GraphQL spec.

getPath() - Method in interface org.springframework.graphql.ResponseError

Return a String representation of the parsed path, or an empty String if the error is not associated with a field.

getPath() - Method in interface org.springframework.graphql.ResponseField

Return a String representation of the field path as described in ClientGraphQlResponse.field(String).

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

Return the payload.

getPrincipal() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo

Return the principal associated with the handshake request, if any.

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

Return underlying projection factory used by the resolver.

getProperties(DataFetchingEnvironment) - Method in class org.springframework.graphql.data.query.AbstractSortStrategy

Return the sort properties to use, or an empty list if there are none.

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.

getReturnType() - Method in interface org.springframework.graphql.execution.SelfDescribingDataFetcher

The type that the DataFetcher returns.

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

Return the actual return value type.

getSessionInfo() - Method in class org.springframework.graphql.server.WebSocketGraphQlRequest

Return information about the underlying WebSocket session.

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

Return a short representation of this handler method for log message purposes.

getSubProtocols() - Method in class org.springframework.graphql.server.webflux.GraphQlWebSocketHandler

getSubProtocols() - Method in class org.springframework.graphql.server.webmvc.GraphQlWebSocketHandler

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

Return the message type value as it should appear on the wire.

getType(TypeResolutionEnvironment) - Method in class org.springframework.graphql.execution.ClassNameTypeResolver

getUri() - Method in class org.springframework.graphql.server.WebGraphQlRequest

Return the URL for the HTTP request or WebSocket handshake.

getUri() - Method in interface org.springframework.graphql.server.WebSocketSessionInfo

Return the URL for the WebSocket endpoint.

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

getValue() - Method in class org.springframework.graphql.observation.DataFetcherObservationContext

Return the value returned by the DataFetcher, if any.

getValue() - Method in interface org.springframework.graphql.ResponseField

Return the raw field value, e.g.

getVariables() - Method in interface org.springframework.graphql.GraphQlRequest

Return values for variable defined by the operation.

getVariables() - Method in class org.springframework.graphql.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 - Class in org.springframework.graphql.server.webmvc

Spring MVC handler to serve a GraphiQl UI page.

GraphiQlHandler(String, String) - Constructor for class org.springframework.graphql.server.webflux.GraphiQlHandler

Constructor that serves the default graphiql/index.html included in the spring-graphql module.

GraphiQlHandler(String, String) - Constructor for class org.springframework.graphql.server.webmvc.GraphiQlHandler

Constructor that serves the default graphiql/index.html included in the spring-graphql module.

GraphiQlHandler(String, String, Resource) - Constructor for class org.springframework.graphql.server.webflux.GraphiQlHandler

Constructor with the HTML page to serve.

GraphiQlHandler(String, String, Resource) - Constructor for class org.springframework.graphql.server.webmvc.GraphiQlHandler

Constructor with the HTML page to serve.

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

Return the GraphQL to use.

GraphQlArgumentBinder - Class in org.springframework.graphql.data

Binder that instantiates and populates a target Object to reflect the complete structure of the GraphQL arguments input map.

GraphQlArgumentBinder() - Constructor for class org.springframework.graphql.data.GraphQlArgumentBinder

GraphQlArgumentBinder(ConversionService) - Constructor for class org.springframework.graphql.data.GraphQlArgumentBinder

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.

GraphQlContextAccessor - Class in org.springframework.graphql.execution

ContextAccessor that enables support for reading and writing values to and from a GraphQLContext.

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

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

Declares a method as a handler of exceptions raised while fetching data for a field.

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

WebFlux.fn Handler for GraphQL over HTTP requests.

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

GraphQL handler to expose as a WebMvc.fn endpoint via RouterFunctions.

GraphQlHttpHandler(WebGraphQlHandler) - Constructor for class org.springframework.graphql.server.webflux.GraphQlHttpHandler

Create a new instance.

GraphQlHttpHandler(WebGraphQlHandler) - Constructor for class org.springframework.graphql.server.webmvc.GraphQlHttpHandler

Create a new instance.

GraphQlObservationDocumentation - Enum Class in org.springframework.graphql.observation

Documented KeyValues for GraphQL server observations.

GraphQlObservationDocumentation.DataFetcherHighCardinalityKeyNames - Enum Class in org.springframework.graphql.observation

GraphQlObservationDocumentation.DataFetcherLowCardinalityKeyNames - Enum Class in org.springframework.graphql.observation

GraphQlObservationDocumentation.ExecutionRequestHighCardinalityKeyNames - Enum Class in org.springframework.graphql.observation

GraphQlObservationDocumentation.ExecutionRequestLowCardinalityKeyNames - Enum Class in org.springframework.graphql.observation

GraphQlObservationInstrumentation - Class in org.springframework.graphql.observation

Instrumentation that creates observations for GraphQL requests and data fetcher operations.

GraphQlObservationInstrumentation(ObservationRegistry) - Constructor for class org.springframework.graphql.observation.GraphQlObservationInstrumentation

Create an GraphQlObservationInstrumentation that records observations against the given ObservationRegistry.

GraphQlObservationInstrumentation(ObservationRegistry, ExecutionRequestObservationConvention, DataFetcherObservationConvention) - Constructor for class org.springframework.graphql.observation.GraphQlObservationInstrumentation

Create an GraphQlObservationInstrumentation that records observations against the given ObservationRegistry with a custom convention.

GraphQlRepository - Annotation Interface in org.springframework.graphql.data

Specialization of the Repository stereotype that marks a repository as intended for use in a GraphQL application for data fetching.

GraphQlRequest - Interface in org.springframework.graphql

Represents a GraphQL request with the inputs to pass to a GraphQL service including a document, operationName, and variables.

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.

GraphQlTester - Interface in org.springframework.graphql.test.tester

Define a workflow to test GraphQL requests that is independent of the underlying transport.

GraphQlTester.Builder<B extends GraphQlTester.Builder<B>> - Interface in org.springframework.graphql.test.tester

A builder to create a GraphQlTester instance.

GraphQlTester.Entity<D,S extends GraphQlTester.Entity<D,S>> - Interface in org.springframework.graphql.test.tester

Contains a decoded entity and provides options to assert it

GraphQlTester.EntityList<E> - Interface in org.springframework.graphql.test.tester

Contains a List of decoded entities and provides options to assert them.

GraphQlTester.Errors - Interface in org.springframework.graphql.test.tester

Declare options to filter out expected errors or inspect all errors and verify there are no unexpected errors.

GraphQlTester.Path - Interface in org.springframework.graphql.test.tester

Options available to assert the response values at the current path.

GraphQlTester.Request<T extends GraphQlTester.Request<T>> - Interface in org.springframework.graphql.test.tester

Declare options to gather input for a GraphQL request and execute it.

GraphQlTester.Response - Interface in org.springframework.graphql.test.tester

Declare options to check the data and errors of a GraphQL response.

GraphQlTester.Subscription - Interface in org.springframework.graphql.test.tester

Declare options available to assert a GraphQL Subscription response.

GraphQlTester.Traversable - Interface in org.springframework.graphql.test.tester

Declare options to switch to different part of the GraphQL response.

GraphQlTransport - Interface in org.springframework.graphql.client

Contract for executing GraphQL requests over some transport.

GraphQlTransportException - Exception in org.springframework.graphql.client

Exception raised by a GraphQlTransport or used to wrap an exception from a GraphQlTransport implementation.

GraphQlTransportException(String, Throwable, GraphQlRequest) - Constructor for exception org.springframework.graphql.client.GraphQlTransportException

Constructor with a given message.

GraphQlTransportException(Throwable, GraphQlRequest) - Constructor for exception org.springframework.graphql.client.GraphQlTransportException

Constructor with a default message.

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

WebSocketHandler for GraphQL based on GraphQL Over WebSocket Protocol and for use in a Spring WebFlux application.

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

WebSocketHandler for GraphQL based on GraphQL Over WebSocket Protocol and for use on a Servlet container with spring-websocket.

GraphQlWebSocketHandler(WebGraphQlHandler, CodecConfigurer, Duration) - Constructor for class org.springframework.graphql.server.webflux.GraphQlWebSocketHandler

Create a new instance.

GraphQlWebSocketHandler(WebGraphQlHandler, 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 Class in org.springframework.graphql.server.support

Enum for a message type as defined in the GraphQL over WebSocket spec proposal.

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|Serialized Form