Package org.springframework.integration.graphql.outbound

Class GraphQlMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractMessageProducingHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.graphql.outbound.GraphQlMessageHandler

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ComponentSourceAware, ExpressionCapable, Orderable, MessageProducer, HeaderPropagationAware, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

public class GraphQlMessageHandler
extends AbstractReplyProducingMessageHandler

An AbstractReplyProducingMessageHandler capable of fielding GraphQL Query, Mutation and Subscription requests.

Since:

6.0

Author:

Daniel Frey, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

AbstractReplyProducingMessageHandler.RequestHandler

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

messagingTemplate

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
GraphQlMessageHandler(org.springframework.graphql.ExecutionGraphQlService graphQlService)

Method Summary

Modifier and Type	Method	Description
protected final void	doInit()
protected Object	handleRequestMessage(Message<?> requestMessage)	Subclasses must implement this method to handle the request Message.
void	setExecutionIdExpression(Expression executionIdExpression)	Set a SpEL expression to evaluate Execution Id for GraphQL Operation Request to execute.
void	setLocale(Locale locale)	Set a Locale for GraphQL Operation to execute.
void	setOperation(String operation)	Specify a GraphQL Operation.
void	setOperationExpression(Expression operationExpression)	Specify a SpEL expression to evaluate a GraphQL Operation
void	setOperationName(String operationName)	Set a GraphQL Operation Name to execute.
void	setOperationNameExpression(Expression operationNameExpression)	Set a SpEL expression to evaluate a GraphQL Operation Name to execute.
void	setVariablesExpression(Expression variablesExpression)	Set a SpEL expression to evaluate Variables for GraphQL Operation to execute.

Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler

doInvokeAdvisedRequestHandler, getBeanClassLoader, getIntegrationPatternType, getRequiresReply, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setRequiresReply

Methods inherited from class org.springframework.integration.handler.AbstractMessageProducingHandler

addNotPropagatedHeaders, createOutputMessage, getNotPropagatedHeaders, getOutputChannel, isAsync, messageBuilderForReply, produceOutput, resolveErrorChannel, sendErrorMessage, sendOutput, sendOutputs, setAsync, setNotPropagatedHeaders, setOutputChannel, setOutputChannelName, setSendTimeout, setupMessageProcessor, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport

buildSendTimer, destroy, getComponentType, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Constructor Details

GraphQlMessageHandler

public GraphQlMessageHandler(org.springframework.graphql.ExecutionGraphQlService graphQlService)

Method Details

setOperation

public void setOperation(String operation)

Specify a GraphQL Operation.

Parameters:

operation - the GraphQL operation to use.

setOperationExpression

public void setOperationExpression(Expression operationExpression)

Specify a SpEL expression to evaluate a GraphQL Operation

Parameters:

operationExpression - the expression to evaluate a GraphQL Operation.

setOperationName

public void setOperationName(String operationName)

Set a GraphQL Operation Name to execute.

Parameters:

operationName - the GraphQL Operation Name to use.

setOperationNameExpression

public void setOperationNameExpression(Expression operationNameExpression)

Set a SpEL expression to evaluate a GraphQL Operation Name to execute.

Parameters:

operationNameExpression - the expression to use.

setVariablesExpression

public void setVariablesExpression(Expression variablesExpression)

Set a SpEL expression to evaluate Variables for GraphQL Operation to execute.

Parameters:

variablesExpression - the expression to use.

setLocale

public void setLocale(@Nullable
 Locale locale)

Set a Locale for GraphQL Operation to execute.

Parameters:

locale - the locale to use.

setExecutionIdExpression

public void setExecutionIdExpression(Expression executionIdExpression)

Set a SpEL expression to evaluate Execution Id for GraphQL Operation Request to execute.

Parameters:

executionIdExpression - the executionIdExpression to use.

doInit

protected final void doInit()

Overrides:

doInit in class AbstractReplyProducingMessageHandler

handleRequestMessage

protected Object handleRequestMessage(Message<?> requestMessage)

Description copied from class: AbstractReplyProducingMessageHandler

Subclasses must implement this method to handle the request Message. The return value may be a Message, a MessageBuilder, or any plain Object. The base class will handle the final creation of a reply Message from any of those starting points. If the return value is null, the Message flow will end here.

Specified by:

handleRequestMessage in class AbstractReplyProducingMessageHandler

Parameters:

requestMessage - The request message.

Returns:

The result of handling the message, or null.