org.springframework.integration.http.outbound

Class HttpRequestExecutingMessageHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.AbstractReplyProducingMessageHandler

org.springframework.integration.http.outbound.HttpRequestExecutingMessageHandler

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, Orderable, MessageProducer, TrackableComponent, NamedComponent, MessageHandler

public class HttpRequestExecutingMessageHandler
extends AbstractReplyProducingMessageHandler

A MessageHandler implementation that executes HTTP requests by delegating to a RestTemplate instance. If the 'expectReply' flag is set to true (the default) then a reply Message will be generated from the HTTP response. If that response contains a body, it will be used as the reply Message's payload. Otherwise the reply Message's payload will contain the response status as an instance of the HttpStatus enum. When there is a response body, the HttpStatus enum instance will instead be copied to the MessageHeaders of the reply. In both cases, the response headers will be mapped to the reply Message's headers by this handler's HeaderMapper instance.

Since:

2.0

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Gunnar Hillert, Artem Bilan, Wallace Wadge

Nested Class Summary

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

AbstractReplyProducingMessageHandler.RequestHandler

Field Summary

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

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
HttpRequestExecutingMessageHandler(Expression uriExpression) Create a handler that will send requests to the provided URI Expression.
HttpRequestExecutingMessageHandler(Expression uriExpression, RestTemplate restTemplate) Create a handler that will send requests to the provided URI using a provided RestTemplate
HttpRequestExecutingMessageHandler(String uri) Create a handler that will send requests to the provided URI.
HttpRequestExecutingMessageHandler(String uri, RestTemplate restTemplate) Create a handler that will send requests to the provided URI using a provided RestTemplate
HttpRequestExecutingMessageHandler(URI uri) Create a handler that will send requests to the provided URI.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInit()
String	getComponentType() Subclasses may implement this method to provide component type information.
protected Object	handleRequestMessage(Message<?> requestMessage) Subclasses must implement this method to handle the request Message.
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) Specify whether the real URI should be encoded after uriVariables expanding and before send request via RestTemplate.
void	setErrorHandler(ResponseErrorHandler errorHandler) Set the ResponseErrorHandler for the underlying RestTemplate.
void	setExpectedResponseType(Class<?> expectedResponseType) Specify the expected response type for the REST request otherwise the default response type is ResponseEntity and will be returned as a payload of the reply Message.
void	setExpectedResponseTypeExpression(Expression expectedResponseTypeExpression) Specify the Expression to determine the type for the expected response The returned value of the expression could be an instance of Class or String 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)
void	setHttpMethod(HttpMethod httpMethod) Specify the HttpMethod for requests.
void	setHttpMethodExpression(Expression httpMethodExpression) Specify the SpEL Expression to determine HttpMethod dynamically
void	setMessageConverters(List<HttpMessageConverter<?>> messageConverters) Set a list of HttpMessageConverters to be used by the underlying RestTemplate.
void	setRequestFactory(ClientHttpRequestFactory requestFactory) Set the ClientHttpRequestFactory for the underlying RestTemplate.
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	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 the Expression 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, getMessagingTemplate, handleMessageInternal, hasAdviceChain, onInit, setAdviceChain, setBeanClassLoader, setChannelResolver, setOutputChannel, setOutputChannelName, setRequiresReply, setSendTimeout, shouldCopyRequestHeaders

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

getOrder, handleMessage, setOrder, setShouldTrack

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

afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, 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.context.NamedComponent

getComponentName

Constructor Detail

HttpRequestExecutingMessageHandler

public HttpRequestExecutingMessageHandler(URI uri)

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

Parameters:

uri - The URI.

HttpRequestExecutingMessageHandler

public HttpRequestExecutingMessageHandler(String uri)

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

Parameters:

uri - The URI.

HttpRequestExecutingMessageHandler

public HttpRequestExecutingMessageHandler(Expression uriExpression)

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

Parameters:

uriExpression - The URI expression.

HttpRequestExecutingMessageHandler

public HttpRequestExecutingMessageHandler(String uri,
                                  RestTemplate restTemplate)

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

Parameters:

uri - The URI.

restTemplate - The rest template.

HttpRequestExecutingMessageHandler

public HttpRequestExecutingMessageHandler(Expression uriExpression,
                                  RestTemplate restTemplate)

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

Parameters:

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

restTemplate - The rest template.

Method Detail

setEncodeUri

public void setEncodeUri(boolean encodeUri)

Specify whether the real URI should be encoded after uriVariables expanding and before send request via RestTemplate. The default value is true.

Parameters:

encodeUri - true if the URI should be encoded.

See Also:

UriComponentsBuilder

setHttpMethodExpression

public void setHttpMethodExpression(Expression httpMethodExpression)

Specify the SpEL Expression to determine HttpMethod dynamically

Parameters:

httpMethodExpression - The method expression.

setHttpMethod

public void setHttpMethod(HttpMethod httpMethod)

Specify the HttpMethod for requests. The default method will be POST.

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 will be serialized. The default value is true.

Parameters:

extractPayload - true if the payload should be extracted.

setCharset

public void setCharset(String charset)

Specify the charset name to use for converting String-typed payloads to bytes. The default is 'UTF-8'.

Parameters:

charset - The charset.

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

public void setExpectedResponseType(Class<?> expectedResponseType)

Specify the expected response type for the REST request otherwise the default response type is ResponseEntity 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 see setExpectedResponseTypeExpression(Expression)

setExpectedResponseTypeExpression

public void setExpectedResponseTypeExpression(Expression expectedResponseTypeExpression)

Specify the Expression to determine the type for the expected response The returned value of the expression could be an instance of Class or String representing a fully qualified class name

Parameters:

expectedResponseTypeExpression - The expected response type expression. Also see setExpectedResponseTypeExpression(Expression)

setErrorHandler

public void setErrorHandler(ResponseErrorHandler errorHandler)

Set the ResponseErrorHandler for the underlying RestTemplate.

Parameters:

errorHandler - The error handler.

See Also:

RestTemplate.setErrorHandler(ResponseErrorHandler)

setMessageConverters

public void setMessageConverters(List<HttpMessageConverter<?>> messageConverters)

Set a list of HttpMessageConverters to be used by the underlying RestTemplate. Converters configured via this method will override the default converters.

Parameters:

messageConverters - The message converters.

See Also:

RestTemplate.setMessageConverters(java.util.List)

setHeaderMapper

public void setHeaderMapper(HeaderMapper<HttpHeaders> headerMapper)

Parameters:

headerMapper - The header mapper. Set the HeaderMapper to use when mapping between HTTP headers and MessageHeaders.

setRequestFactory

public void setRequestFactory(ClientHttpRequestFactory requestFactory)

Set the ClientHttpRequestFactory for the underlying RestTemplate.

Parameters:

requestFactory - The request factory.

See Also:

HttpAccessor.setRequestFactory(ClientHttpRequestFactory)

setUriVariableExpressions

public 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.

Parameters:

uriVariableExpressions - The URI variable expressions.

setUriVariablesExpression

public void setUriVariablesExpression(Expression uriVariablesExpression)

Set the Expression 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.

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 AbstractMessageHandler

doInit

protected 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.

mapHeaders

protected HttpHeaders mapHeaders(Message<?> message)