Package org.springframework.integration.webflux.outbound

Class WebFluxRequestExecutingMessageHandler

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.http.outbound.AbstractHttpRequestExecutingMessageHandler

org.springframework.integration.webflux.outbound.WebFluxRequestExecutingMessageHandler

All Implemented Interfaces:

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

public class WebFluxRequestExecutingMessageHandler
extends AbstractHttpRequestExecutingMessageHandler

A MessageHandler implementation that executes HTTP requests by delegating to a Reactive WebClient instance.

Since:

5.0

Author:

Shiliang Li, Artem Bilan, Gary Russell, David Graff, Jatin Saxena

See Also:

• HttpRequestExecutingMessageHandler
• WebClient

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.http.outbound.AbstractHttpRequestExecutingMessageHandler

uriFactory

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
WebFluxRequestExecutingMessageHandler(String uri)	Create a handler that will send requests to the provided URI.
WebFluxRequestExecutingMessageHandler(String uri, WebClient webClient)	Create a handler that will send requests to the provided URI using a provided WebClient.
WebFluxRequestExecutingMessageHandler(URI uri)	Create a handler that will send requests to the provided URI.
WebFluxRequestExecutingMessageHandler(Expression uriExpression)	Create a handler that will send requests to the provided URI Expression.
WebFluxRequestExecutingMessageHandler(Expression uriExpression, WebClient webClient)	Create a handler that will send requests to the provided URI using a provided WebClient.

Method Summary

Modifier and Type	Method	Description
protected final void	doInit()
protected Object	exchange(Object uri, HttpMethod httpMethod, HttpEntity<?> httpRequest, Object expectedResponseType, Message<?> requestMessage, Map<String,?> uriVariables)
String	getComponentType()	Subclasses may implement this method to provide component type information.
void	setAttributeVariablesExpression(Expression attributeVariablesExpression)	Configure expression to evaluate request attribute which will be added to webclient request attribute.
void	setBodyExtractor(BodyExtractor<?,? super ClientHttpResponse> bodyExtractor)	Specify a BodyExtractor as an alternative to the expectedResponseType to allow to get low-level access to the received ClientHttpResponse.
void	setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)	Set the encoding mode to use.
void	setPublisherElementType(Class<?> publisherElementType)	Configure a type for a request Publisher elements.
void	setPublisherElementTypeExpression(Expression publisherElementTypeExpression)	Configure a SpEL expression to evaluate a request Publisher elements type at runtime against a request message.
void	setReplyPayloadToFlux(boolean replyPayloadToFlux)	The boolean flag to identify if the reply payload should be as a Flux from the response body or as resolved value from the Mono of the response body.

Methods inherited from class org.springframework.integration.http.outbound.AbstractHttpRequestExecutingMessageHandler

evaluateTypeFromExpression, getIntegrationPatternType, getReply, handleRequestMessage, isExpectReply, mapHeaders, setCharset, setExpectedResponseType, setExpectedResponseTypeExpression, setExpectReply, setExtractPayload, setExtractResponseBody, setHeaderMapper, setHttpMethod, setHttpMethodExpression, setTransferCookies, setTrustedSpel, setUriVariableExpressions, setUriVariablesExpression

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

doInvokeAdvisedRequestHandler, getBeanClassLoader, 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, 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, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, 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

WebFluxRequestExecutingMessageHandler

public WebFluxRequestExecutingMessageHandler(URI uri)

Create a handler that will send requests to the provided URI.

Parameters:

uri - The URI.

WebFluxRequestExecutingMessageHandler

public WebFluxRequestExecutingMessageHandler(String uri)

Create a handler that will send requests to the provided URI.

Parameters:

uri - The URI.

WebFluxRequestExecutingMessageHandler

public WebFluxRequestExecutingMessageHandler(Expression uriExpression)

Create a handler that will send requests to the provided URI Expression.

Parameters:

uriExpression - The URI expression.

WebFluxRequestExecutingMessageHandler

public WebFluxRequestExecutingMessageHandler(String uri,
 @Nullable
 WebClient webClient)

Create a handler that will send requests to the provided URI using a provided WebClient.

Parameters:

uri - The URI.

webClient - The WebClient to use.

WebFluxRequestExecutingMessageHandler

public WebFluxRequestExecutingMessageHandler(Expression uriExpression,
 @Nullable
 WebClient webClient)

Create a handler that will send requests to the provided URI using a provided WebClient.

Parameters:

uriExpression - A SpEL Expression that can be resolved against the message object and BeanFactory.

webClient - The WebClient to use.

Method Details

setEncodingMode

public void setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)

Description copied from class: AbstractHttpRequestExecutingMessageHandler

Set the encoding mode to use. By default, this is set to DefaultUriBuilderFactory.EncodingMode.TEMPLATE_AND_VALUES. For more complicated scenarios consider configuring an UriTemplateHandler on an externally provided RestTemplate.

Overrides:

setEncodingMode in class AbstractHttpRequestExecutingMessageHandler

Parameters:

encodingMode - the mode to use for uri encoding

setReplyPayloadToFlux

public void setReplyPayloadToFlux(boolean replyPayloadToFlux)

The boolean flag to identify if the reply payload should be as a Flux from the response body or as resolved value from the Mono of the response body. Defaults to false - simple value is pushed downstream. Makes sense when expectedResponseType is configured.

Parameters:

replyPayloadToFlux - represent reply payload as a Flux or as a value from the Mono.

Since:

5.0.1

See Also:

• AbstractHttpRequestExecutingMessageHandler.setExpectedResponseType(Class)
• AbstractHttpRequestExecutingMessageHandler.setExpectedResponseTypeExpression(Expression)

setBodyExtractor

public void setBodyExtractor(BodyExtractor<?,? super ClientHttpResponse> bodyExtractor)

Specify a BodyExtractor as an alternative to the expectedResponseType to allow to get low-level access to the received ClientHttpResponse.

Parameters:

bodyExtractor - the BodyExtractor to use.

Since:

5.0.1

See Also:

• AbstractHttpRequestExecutingMessageHandler.setExpectedResponseType(Class)
• AbstractHttpRequestExecutingMessageHandler.setExpectedResponseTypeExpression(Expression)

setPublisherElementType

public void setPublisherElementType(Class<?> publisherElementType)

Configure a type for a request Publisher elements.

Parameters:

publisherElementType - the type of the request Publisher elements.

Since:

5.2

See Also:

• BodyInserters.fromPublisher(Publisher, Class)

setPublisherElementTypeExpression

public void setPublisherElementTypeExpression(Expression publisherElementTypeExpression)

Configure a SpEL expression to evaluate a request Publisher elements type at runtime against a request message.

Parameters:

publisherElementTypeExpression - the expression to evaluate a type for the request Publisher elements.

Since:

5.2

See Also:

• BodyInserters.fromPublisher(Publisher, Class)
• BodyInserters.fromPublisher(Publisher, ParameterizedTypeReference)

setAttributeVariablesExpression

public void setAttributeVariablesExpression(Expression attributeVariablesExpression)

Configure expression to evaluate request attribute which will be added to webclient request attribute.

Parameters:

attributeVariablesExpression - the expression to evaluate request attribute.

Since:

6.0

See Also:

• WebClient.RequestHeadersSpec.attributes(java.util.function.Consumer<java.util.Map<java.lang.String, java.lang.Object>>)

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageHandlerSupport

doInit

protected final void doInit()

Overrides:

doInit in class AbstractHttpRequestExecutingMessageHandler

exchange

@Nullable
protected Object exchange(Object uri,
 HttpMethod httpMethod,
 HttpEntity<?> httpRequest,
 Object expectedResponseType,
 Message<?> requestMessage,
 Map<String,?> uriVariables)

Specified by:

exchange in class AbstractHttpRequestExecutingMessageHandler