Class AbstractHttpRequestExecutingMessageHandler
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
- 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<?>>
- Direct Known Subclasses:
HttpRequestExecutingMessageHandler
,WebFluxRequestExecutingMessageHandler
public abstract class AbstractHttpRequestExecutingMessageHandler extends AbstractReplyProducingMessageHandler
Base class for http outbound adapter/gateway.
- Since:
- 5.0
- Author:
- Mark Fisher, Oleg Zhurakousky, Gary Russell, Gunnar Hillert, Artem Bilan, Wallace Wadge, Shiliang Li, Florian Schöffl
-
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 Modifier and Type Field Description protected DefaultUriBuilderFactory
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 AbstractHttpRequestExecutingMessageHandler(Expression uriExpression)
-
Method Summary
Modifier and Type Method Description protected void
doInit()
protected Object
evaluateTypeFromExpression(Message<?> requestMessage, Expression expression, String property)
protected abstract Object
exchange(Object uri, HttpMethod httpMethod, HttpEntity<?> httpRequest, Object expectedResponseType, Message<?> requestMessage, Map<String,?> uriVariables)
IntegrationPatternType
getIntegrationPatternType()
Return a pattern type this component implements.protected Object
getReply(ResponseEntity<?> httpResponse)
protected Object
handleRequestMessage(Message<?> requestMessage)
Subclasses must implement this method to handle the request Message.boolean
isExpectReply()
protected HttpHeaders
mapHeaders(Message<?> message)
void
setCharset(String charset)
Specify the charset name to use for converting String-typed payloads to bytes.void
setEncodeUri(boolean encodeUri)
Deprecated.since 5.3 in favor ofsetEncodingMode(org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode)
void
setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)
Set the encoding mode to use.void
setExpectedResponseType(Class<?> expectedResponseType)
Specify the expected response type for the REST request otherwise the default response type isResponseEntity
and will be returned as a payload of the reply Message.void
setExpectedResponseTypeExpression(Expression expectedResponseTypeExpression)
Specify theExpression
to determine the type for the expected response The returned value of the expression could be an instance ofClass
orString
representing a fully qualified class name.void
setExpectReply(boolean expectReply)
Specify whether a reply Message is expected.void
setExtractPayload(boolean extractPayload)
Specify whether the outbound message's payload should be extracted when preparing the request body.void
setHeaderMapper(HeaderMapper<HttpHeaders> headerMapper)
Set theHeaderMapper
to use when mapping between HTTP headers and MessageHeaders.void
setHttpMethod(HttpMethod httpMethod)
Specify theHttpMethod
for requests.void
setHttpMethodExpression(Expression httpMethodExpression)
Specify the SpELExpression
to determineHttpMethod
at runtime.void
setTransferCookies(boolean transferCookies)
Set to true if you wish 'Set-Cookie' headers in responses to be transferred as 'Cookie' headers in subsequent interactions for a message.void
setTrustedSpel(boolean trustedSpel)
Set to true if you trust the source of SpEL expressions used to evaluate URI variables.void
setUriVariableExpressions(Map<String,Expression> uriVariableExpressions)
Set the Map of URI variable expressions to evaluate against the outbound message when replacing the variable placeholders in a URI template.void
setUriVariablesExpression(Expression uriVariablesExpression)
Set theExpression
to evaluate against the outbound message; the expression must evaluate to a Map of URI variable expressions to evaluate against the outbound message when replacing the variable placeholders in a URI template.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, shouldCopyRequestHeaders, shouldSplitOutput, updateNotPropagatedHeaders
Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler
handleMessage, onComplete, onError, onNext, onSubscribe
Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport
buildSendTimer, destroy, getComponentType, getManagedName, getManagedType, getMetricsCaptor, getOrder, getOverrides, isLoggingEnabled, registerMetricsCaptor, 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 org.springframework.integration.support.management.IntegrationManagement
getThisAs
Methods inherited from interface org.springframework.integration.support.context.NamedComponent
getBeanName, getComponentName
-
Field Details
-
Constructor Details
-
Method Details
-
setEncodeUri
Deprecated.since 5.3 in favor ofsetEncodingMode(org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode)
Specify whether the real URI should be encoded afteruriVariables
expanding and before send request viaRestTemplate
. The default value istrue
.- Parameters:
encodeUri
- true if the URI should be encoded.- See Also:
UriComponentsBuilder
-
setEncodingMode
Set the encoding mode to use. By default this is set toDefaultUriBuilderFactory.EncodingMode.TEMPLATE_AND_VALUES
. For more complicated scenarios consider to configure anUriTemplateHandler
on an externally providedRestTemplate
.- Parameters:
encodingMode
- the mode to use for uri encoding- Since:
- 5.3
-
setHttpMethodExpression
Specify the SpELExpression
to determineHttpMethod
at runtime.- Parameters:
httpMethodExpression
- The method expression.
-
setHttpMethod
Specify theHttpMethod
for requests. The default method isPOST
.- Parameters:
httpMethod
- The method.
-
setExtractPayload
public void setExtractPayload(boolean extractPayload)Specify whether the outbound message's payload should be extracted when preparing the request body. Otherwise the Message instance itself is serialized. The default value istrue
.- Parameters:
extractPayload
- true if the payload should be extracted.
-
setCharset
Specify the charset name to use for converting String-typed payloads to bytes. The default isUTF-8
.- Parameters:
charset
- The charset.
-
isExpectReply
public boolean isExpectReply()- Returns:
- whether a reply Message is expected.
- See Also:
setExpectReply(boolean)
-
setExpectReply
public void setExpectReply(boolean expectReply)Specify whether a reply Message is expected. If not, this handler will simply return null for a successful response or throw an Exception for a non-successful response. The default is true.- Parameters:
expectReply
- true if a reply is expected.
-
setExpectedResponseType
Specify the expected response type for the REST request otherwise the default response type isResponseEntity
and will be returned as a payload of the reply Message. To take advantage of the HttpMessageConverters registered on this adapter, provide a different type).- Parameters:
expectedResponseType
- The expected type. Also seesetExpectedResponseTypeExpression(Expression)
-
setExpectedResponseTypeExpression
Specify theExpression
to determine the type for the expected response The returned value of the expression could be an instance ofClass
orString
representing a fully qualified class name.- Parameters:
expectedResponseTypeExpression
- The expected response type expression. Also seesetExpectedResponseType(java.lang.Class<?>)
-
setHeaderMapper
Set theHeaderMapper
to use when mapping between HTTP headers and MessageHeaders.- Parameters:
headerMapper
- The header mapper.
-
setUriVariableExpressions
Set the Map of URI variable expressions to evaluate against the outbound message when replacing the variable placeholders in a URI template.- Parameters:
uriVariableExpressions
- The URI variable expressions.
-
setUriVariablesExpression
Set theExpression
to evaluate against the outbound message; the expression must evaluate to a Map of URI variable expressions to evaluate against the outbound message when replacing the variable placeholders in a URI template.- Parameters:
uriVariablesExpression
- The URI variables expression.
-
setTransferCookies
public void setTransferCookies(boolean transferCookies)Set to true if you wish 'Set-Cookie' headers in responses to be transferred as 'Cookie' headers in subsequent interactions for a message.- Parameters:
transferCookies
- the transferCookies to set.
-
setTrustedSpel
public void setTrustedSpel(boolean trustedSpel)Set to true if you trust the source of SpEL expressions used to evaluate URI variables. Default is false, which means aSimpleEvaluationContext
is used for evaluating such expressions, which restricts the use of some SpEL capabilities.- Parameters:
trustedSpel
- true to trust.- Since:
- 4.3.15.
-
getIntegrationPatternType
Description copied from interface:IntegrationPattern
Return a pattern type this component implements.- Specified by:
getIntegrationPatternType
in interfaceIntegrationPattern
- Overrides:
getIntegrationPatternType
in classAbstractReplyProducingMessageHandler
- Returns:
- the
IntegrationPatternType
this component implements.
-
doInit
protected void doInit()- Overrides:
doInit
in classAbstractReplyProducingMessageHandler
-
handleRequestMessage
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 classAbstractReplyProducingMessageHandler
- Parameters:
requestMessage
- The request message.- Returns:
- The result of handling the message, or
null
.
-
exchange
@Nullable protected abstract Object exchange(Object uri, HttpMethod httpMethod, HttpEntity<?> httpRequest, Object expectedResponseType, Message<?> requestMessage, Map<String,?> uriVariables) -
getReply
-
mapHeaders
-
evaluateTypeFromExpression
-