- getArgumentResolver(MethodParameter) - Method in class org.springframework.graphql.data.method.HandlerMethodArgumentResolverComposite
-
- 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
-
- getExecutionId() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlRequest
-
- getExecutionInput() - Method in interface org.springframework.graphql.ExecutionGraphQlResponse
-
- getExecutionInput() - Method in class org.springframework.graphql.support.DefaultExecutionGraphQlResponse
-
- getExecutionResult() - Method in interface org.springframework.graphql.ExecutionGraphQlResponse
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- GraphQlSource.Builder<B extends GraphQlSource.Builder<B>> - Interface in org.springframework.graphql.execution
-
- GraphQlSource.SchemaResourceBuilder - Interface in org.springframework.graphql.execution
-
- 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
-
- 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
-
- 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.
- 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
-
- 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
-
- 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.