Index
All Classes and Interfaces|All Packages|Constant Field Values
C
- customize(ExecutionInput, HttpRequest, MutableHttpResponse<String>) - Method in class io.micronaut.configuration.graphql.DefaultGraphQLExecutionInputCustomizer
-
Customizes the GraphQL execution input.
- customize(ExecutionInput, HttpRequest, MutableHttpResponse<String>) - Method in interface io.micronaut.configuration.graphql.GraphQLExecutionInputCustomizer
-
Customizes the GraphQL execution input.
D
- DEFAULT_ENABLED - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration
-
The default enabled value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The default enabled value.
- DEFAULT_ENABLED - Static variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
The default enabled value.
- DEFAULT_KEEP_ALIVE_ENABLED - Static variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
The default keep alive enabled value.
- DEFAULT_KEEP_ALIVE_INTERVAL - Static variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
The default keep alive interval value.
- DEFAULT_PAGE_TITLE - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The default GraphiQL page title.
- DEFAULT_PATH - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration
-
The default GraphQL path.
- DEFAULT_PATH - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The default GraphiQL path.
- DEFAULT_PATH - Static variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
The default GraphQL websocket path.
- DEFAULT_TEMPLATE_PARAMETERS - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The default GraphiQL template parameters.
- DEFAULT_TEMPLATE_PATH - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The default GraphiQL template path.
- DEFAULT_VERSION - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The default GraphiQL version.
- DefaultGraphQLExecutionInputCustomizer - Class in io.micronaut.configuration.graphql
-
The default implementation for customizing GraphQL execution inputs.
- DefaultGraphQLExecutionInputCustomizer() - Constructor for class io.micronaut.configuration.graphql.DefaultGraphQLExecutionInputCustomizer
- DefaultGraphQLExecutionResultHandler - Class in io.micronaut.configuration.graphql
-
The default implementation for handling GraphQL
ExecutionResult
s. - DefaultGraphQLExecutionResultHandler() - Constructor for class io.micronaut.configuration.graphql.DefaultGraphQLExecutionResultHandler
- DefaultGraphQLInvocation - Class in io.micronaut.configuration.graphql
-
The default implementation for invoking GraphQL requests.
- DefaultGraphQLInvocation(GraphQL, GraphQLExecutionInputCustomizer, BeanProvider<DataLoaderRegistry>) - Constructor for class io.micronaut.configuration.graphql.DefaultGraphQLInvocation
-
Default constructor.
- deserialize(String, Class<T>) - Method in interface io.micronaut.configuration.graphql.GraphQLJsonSerializer
-
Deserializes the given json
String
to an object of the required type. - deserialize(String, Class<T>) - Method in class io.micronaut.configuration.graphql.JacksonGraphQLJsonSerializer
-
Deserializes the given json
String
to an object of the required type.
E
- enabled - Variable in class io.micronaut.configuration.graphql.GraphQLConfiguration
- enabled - Variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
- enabled - Variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
- ENABLED - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration
-
The configuration name whether GraphQL is enabled.
- ENABLED - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The configuration name whether GraphiQL is enabled.
- ENABLED - Static variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
The configuration name whether the GraphQL websocket is enabled.
G
- get() - Method in class io.micronaut.configuration.graphql.GraphiQLController
-
Handles the incoming GraphiQL
GET
requests. - get(String, String, String, HttpRequest) - Method in class io.micronaut.configuration.graphql.GraphQLController
-
Handles GraphQL
GET
requests. - getGraphiql() - Method in class io.micronaut.configuration.graphql.GraphQLConfiguration
-
Returns the GraphiQL configuration.
- getId() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsRequest
-
Get the id.
- getId() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsResponse
-
Get the id.
- getKeepAliveInterval() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
Returns the GraphQL keep alive interval in seconds.
- getOperationName() - Method in class io.micronaut.configuration.graphql.GraphQLInvocationData
-
Returns the operation name.
- getOperationName() - Method in class io.micronaut.configuration.graphql.GraphQLRequestBody
-
Returns the operation name.
- getPageTitle() - Method in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
Returns the GraphiQL page title.
- getPath() - Method in class io.micronaut.configuration.graphql.GraphQLConfiguration
-
Returns the GraphQL path.
- getPath() - Method in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
Returns the GraphiQL path.
- getPath() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
Returns the GraphQL websocket path.
- getPayload() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsRequest
-
Get the payload.
- getPayload() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsResponse
-
Get the payload.
- getQuery() - Method in class io.micronaut.configuration.graphql.GraphQLInvocationData
-
Returns the query.
- getQuery() - Method in class io.micronaut.configuration.graphql.GraphQLRequestBody
-
Returns the query.
- getSpecification() - Method in class io.micronaut.configuration.graphql.GraphQLResponseBody
-
Returns the GraphQL response body data.
- getTemplateParameters() - Method in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
Returns the GraphiQL template parameters to be substituted in the template.
- getTemplatePath() - Method in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
Returns the GraphiQL template path.
- getType() - Method in enum class io.micronaut.configuration.graphql.ws.GraphQLWsRequest.ClientType
-
Get the type.
- getType() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsRequest
-
Get the type.
- getType() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsResponse
-
Get the type.
- getType() - Method in enum class io.micronaut.configuration.graphql.ws.GraphQLWsResponse.ServerType
-
Get the type.
- getVariables() - Method in class io.micronaut.configuration.graphql.GraphQLInvocationData
-
Returns the variables.
- getVariables() - Method in class io.micronaut.configuration.graphql.GraphQLRequestBody
-
Returns the variables.
- getVersion() - Method in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
Returns the GraphiQL version.
- GQL_COMPLETE - Enum constant in enum class io.micronaut.configuration.graphql.ws.GraphQLWsResponse.ServerType
- GQL_CONNECTION_ACK - Enum constant in enum class io.micronaut.configuration.graphql.ws.GraphQLWsResponse.ServerType
- GQL_CONNECTION_ERROR - Enum constant in enum class io.micronaut.configuration.graphql.ws.GraphQLWsResponse.ServerType
- GQL_CONNECTION_INIT - Enum constant in enum class io.micronaut.configuration.graphql.ws.GraphQLWsRequest.ClientType
- GQL_CONNECTION_KEEP_ALIVE - Enum constant in enum class io.micronaut.configuration.graphql.ws.GraphQLWsResponse.ServerType
- GQL_CONNECTION_TERMINATE - Enum constant in enum class io.micronaut.configuration.graphql.ws.GraphQLWsRequest.ClientType
- GQL_DATA - Enum constant in enum class io.micronaut.configuration.graphql.ws.GraphQLWsResponse.ServerType
- GQL_ERROR - Enum constant in enum class io.micronaut.configuration.graphql.ws.GraphQLWsResponse.ServerType
- GQL_START - Enum constant in enum class io.micronaut.configuration.graphql.ws.GraphQLWsRequest.ClientType
- GQL_STOP - Enum constant in enum class io.micronaut.configuration.graphql.ws.GraphQLWsRequest.ClientType
- graphiql - Variable in class io.micronaut.configuration.graphql.GraphQLConfiguration
- GraphiQLConfiguration() - Constructor for class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
- GraphiQLController - Class in io.micronaut.configuration.graphql
-
The GraphiQL controller serving the GraphiQL HTML page.
- GraphiQLController(GraphQLConfiguration, GraphQLWsConfiguration, ResourceResolver, ConversionService) - Constructor for class io.micronaut.configuration.graphql.GraphiQLController
-
Default constructor.
- GraphQLConfiguration - Class in io.micronaut.configuration.graphql
-
Configuration properties for GraphQL.
- GraphQLConfiguration() - Constructor for class io.micronaut.configuration.graphql.GraphQLConfiguration
- GraphQLConfiguration.GraphiQLConfiguration - Class in io.micronaut.configuration.graphql
-
Configuration properties for GraphiQL.
- GraphQLController - Class in io.micronaut.configuration.graphql
-
The GraphQL controller handling GraphQL requests.
- GraphQLController(GraphQLInvocation, GraphQLExecutionResultHandler, GraphQLJsonSerializer) - Constructor for class io.micronaut.configuration.graphql.GraphQLController
-
Default constructor.
- GraphQLExecutionInputCustomizer - Interface in io.micronaut.configuration.graphql
-
An interface for customizing the
ExecutionInput
. - GraphQLExecutionResultHandler - Interface in io.micronaut.configuration.graphql
-
An interface for handling GraphQL
ExecutionResult
s. - GraphQLInvocation - Interface in io.micronaut.configuration.graphql
-
An interface for invoking GraphQL request.
- GraphQLInvocationData - Class in io.micronaut.configuration.graphql
-
Represents the data to execute a GraphQL query.
- GraphQLInvocationData(String, String, Map<String, Object>) - Constructor for class io.micronaut.configuration.graphql.GraphQLInvocationData
-
Default constructor.
- GraphQLJsonSerializer - Interface in io.micronaut.configuration.graphql
-
An interface for serializing and deserializing GraphQL objects.
- GraphQLRequestBody - Class in io.micronaut.configuration.graphql
-
Represents the request body input data to execute a GraphQL query.
- GraphQLRequestBody() - Constructor for class io.micronaut.configuration.graphql.GraphQLRequestBody
- GraphQLResponseBody - Class in io.micronaut.configuration.graphql
-
Represents the response body output data of an executed GraphQL query.
- GraphQLResponseBody(Map<String, Object>) - Constructor for class io.micronaut.configuration.graphql.GraphQLResponseBody
-
Default constructor.
- GraphQLWsConfiguration - Class in io.micronaut.configuration.graphql.ws
-
Configuration properties for using a web socket with GraphQL.
- GraphQLWsConfiguration() - Constructor for class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
- GraphQLWsController - Class in io.micronaut.configuration.graphql.ws
-
The GraphQL websocket controller handling GraphQL requests.
- GraphQLWsController(GraphQLWsMessageHandler, GraphQLWsState, GraphQLJsonSerializer) - Constructor for class io.micronaut.configuration.graphql.ws.GraphQLWsController
-
Default constructor.
- GraphQLWsKeepAlive - Class in io.micronaut.configuration.graphql.ws
-
Used to send keep alive messages to the active sessions at a regular interval.
- GraphQLWsKeepAlive(WebSocketBroadcaster, GraphQLWsState, GraphQLJsonSerializer) - Constructor for class io.micronaut.configuration.graphql.ws.GraphQLWsKeepAlive
-
Default constructor.
- GraphQLWsMessageHandler - Class in io.micronaut.configuration.graphql.ws
-
Handles the messages send over the websocket.
- GraphQLWsMessageHandler(GraphQLWsConfiguration, GraphQLWsState, GraphQLInvocation, GraphQLExecutionResultHandler, GraphQLWsSender) - Constructor for class io.micronaut.configuration.graphql.ws.GraphQLWsMessageHandler
-
Default constructor.
- GraphQLWsRequest - Class in io.micronaut.configuration.graphql.ws
-
Class to handle the message to and from the websocket.
- GraphQLWsRequest() - Constructor for class io.micronaut.configuration.graphql.ws.GraphQLWsRequest
- GraphQLWsRequest.ClientType - Enum Class in io.micronaut.configuration.graphql.ws
-
Types of messages received from the client.
- GraphQLWsResponse - Class in io.micronaut.configuration.graphql.ws
-
Class to handle the message to and from the websocket.
- GraphQLWsResponse(GraphQLWsResponse.ServerType) - Constructor for class io.micronaut.configuration.graphql.ws.GraphQLWsResponse
-
Constructor for messages with just the type, like errors.
- GraphQLWsResponse(GraphQLWsResponse.ServerType, String) - Constructor for class io.micronaut.configuration.graphql.ws.GraphQLWsResponse
-
Constructor for messages with only serverType and id, like the stop message.
- GraphQLWsResponse(GraphQLWsResponse.ServerType, String, GraphQLResponseBody) - Constructor for class io.micronaut.configuration.graphql.ws.GraphQLWsResponse
-
Constructor having all the types, like a graphql query response.
- GraphQLWsResponse.ServerType - Enum Class in io.micronaut.configuration.graphql.ws
-
Types of messages send to the client.
- GraphQLWsSender - Class in io.micronaut.configuration.graphql.ws
-
Sends the GraphQL response(s) to the client.
- GraphQLWsSender(GraphQLWsState, GraphQLJsonSerializer) - Constructor for class io.micronaut.configuration.graphql.ws.GraphQLWsSender
-
Default constructor.
H
- handleExecutionResult(Publisher<ExecutionResult>) - Method in class io.micronaut.configuration.graphql.DefaultGraphQLExecutionResultHandler
-
Handles the execution result by converting the provided execution result publisher to a publisher that emits
GraphQLResponseBody
objects. - handleExecutionResult(Publisher<ExecutionResult>) - Method in interface io.micronaut.configuration.graphql.GraphQLExecutionResultHandler
-
Handles the execution result by converting the provided execution result publisher to a publisher that emits
GraphQLResponseBody
objects. - handleMessage(GraphQLWsRequest, WebSocketSession) - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsMessageHandler
-
Handles the request possibly invocating graphql.
I
- invoke(GraphQLInvocationData, HttpRequest, MutableHttpResponse<String>) - Method in class io.micronaut.configuration.graphql.DefaultGraphQLInvocation
-
Invokes the GraphQL request and returns a publisher that emits
ExecutionResult
objects. - invoke(GraphQLInvocationData, HttpRequest, MutableHttpResponse<String>) - Method in interface io.micronaut.configuration.graphql.GraphQLInvocation
-
Invokes the GraphQL request and returns a publisher that emits
ExecutionResult
objects. - io.micronaut.configuration.graphql - package io.micronaut.configuration.graphql
-
Micronaut GraphQL integration.
- io.micronaut.configuration.graphql.ws - package io.micronaut.configuration.graphql.ws
-
Micronaut GraphQL web socket integration.
- isEnabled() - Method in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
Returns whether GraphiQL is enabled.
- isEnabled() - Method in class io.micronaut.configuration.graphql.GraphQLConfiguration
-
Returns whether GraphQL is enabled.
- isEnabled() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
Returns whether GraphQL websocket is enabled.
- isKeepAliveEnabled() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
Returns whether GraphQL websocket keep alive is enabled.
J
- JacksonGraphQLJsonSerializer - Class in io.micronaut.configuration.graphql
-
The Jackson implementation for serializing and deserializing GraphQL objects.
- JacksonGraphQLJsonSerializer(JsonMapper) - Constructor for class io.micronaut.configuration.graphql.JacksonGraphQLJsonSerializer
-
Default constructor.
K
- KEEP_ALIVE_ENABLED - Static variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
The configuration name of the GraphQL keep alive enabled path..
- KEEP_ALIVE_INTERVAL - Static variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
The configuration name of the GraphQL keep alive interval path..
- keepAliveEnabled - Variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
- keepAliveInterval - Variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
- keepAliveSender() - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsKeepAlive
-
Send ka messages to active sessions.
O
- onClose(WebSocketSession, CloseReason) - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsController
-
Called when the websocket is closed.
- onError(WebSocketSession, Throwable) - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsController
-
Called when there is an error with the websocket, this probably means the connection is lost, but hasn't been properly closed.
- onMessage(String, WebSocketSession) - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsController
-
Called on every message received from the client.
- onOpen(WebSocketSession, HttpRequest) - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsController
-
Called when the connection is opened.
P
- PAGE_TITLE - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The configuration name of the GraphiQL page title.
- pageTitle - Variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
- path - Variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
- path - Variable in class io.micronaut.configuration.graphql.GraphQLConfiguration
- path - Variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
- PATH - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The configuration name of the GraphiQL path.
- PATH - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration
-
The configuration name of the GraphQL path.
- PATH - Static variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
The configuration name of the GraphQL websocket path.
- post(String, String, String, String, HttpRequest) - Method in class io.micronaut.configuration.graphql.GraphQLController
-
Handles GraphQL
POST
requests. - PREFIX - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The prefix to use for all GraphiQL configuration properties.
- PREFIX - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration
-
The prefix to use for all GraphQL configuration properties.
- PREFIX - Static variable in class io.micronaut.configuration.graphql.ws.GraphQLWsConfiguration
-
The prefix to use for all GraphQL websocket configuration properties.
R
- RequiresGraphQL - Annotation Interface in io.micronaut.configuration.graphql
-
Meta annotation for GraphQL requirements.
- RequiresGraphQLWs - Annotation Interface in io.micronaut.configuration.graphql.ws
-
Meta annotation for GraphQL web socket requirements.
S
- serialize(Object) - Method in interface io.micronaut.configuration.graphql.GraphQLJsonSerializer
-
Serializes the given object to a json
String
. - serialize(Object) - Method in class io.micronaut.configuration.graphql.JacksonGraphQLJsonSerializer
-
Serializes the given object to a json
String
. - setId(String) - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsRequest
-
Sets the id.
- setOperationName(String) - Method in class io.micronaut.configuration.graphql.GraphQLRequestBody
-
Sets the operation name.
- setPayload(GraphQLRequestBody) - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsRequest
-
Sets the payload.
- setQuery(String) - Method in class io.micronaut.configuration.graphql.GraphQLRequestBody
-
Sets the query.
- setType(String) - Method in class io.micronaut.configuration.graphql.ws.GraphQLWsRequest
-
Sets the type.
- setVariables(Map<String, Object>) - Method in class io.micronaut.configuration.graphql.GraphQLRequestBody
-
Sets the variables.
T
- TEMPLATE_PARAMETERS - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The configuration name of the GraphiQL template parameters.
- TEMPLATE_PATH - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The configuration name of the GraphiQL template path.
- templateParameters - Variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
- templatePath - Variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
V
- valueOf(String) - Static method in enum class io.micronaut.configuration.graphql.ws.GraphQLWsRequest.ClientType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.configuration.graphql.ws.GraphQLWsResponse.ServerType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.micronaut.configuration.graphql.ws.GraphQLWsRequest.ClientType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.configuration.graphql.ws.GraphQLWsResponse.ServerType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version - Variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
- VERSION - Static variable in class io.micronaut.configuration.graphql.GraphQLConfiguration.GraphiQLConfiguration
-
The configuration name of the GraphiQL version.
All Classes and Interfaces|All Packages|Constant Field Values