org.springframework.integration.http.inbound

Class HttpRequestHandlingController

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.gateway.MessagingGatewaySupport

org.springframework.integration.http.inbound.HttpRequestHandlingEndpointSupport

org.springframework.integration.http.inbound.HttpRequestHandlingController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, OrderlyShutdownCapable, TrackableComponent, NamedComponent, org.springframework.web.servlet.mvc.Controller

public class HttpRequestHandlingController
extends HttpRequestHandlingEndpointSupport
implements org.springframework.web.servlet.mvc.Controller

Inbound HTTP endpoint that implements Spring's Controller interface to be used with a DispatcherServlet front controller.

The viewName will be passed into the ModelAndView return value.

This endpoint will have request/reply behavior by default. That can be overridden by passing false to the constructor. In the request/reply case, the core map will be passed to the view, and it will contain either the reply Message or payload depending on the value of HttpRequestHandlingEndpointSupport.extractReplyPayload (true by default, meaning just the payload). The corresponding key in the map is determined by the replyKey property (with a default of "reply").

Since:

2.0

Author:

Mark Fisher, Gary Russell

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
HttpRequestHandlingController()
HttpRequestHandlingController(boolean expectReply)

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.web.servlet.ModelAndView	handleRequest(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Handles the HTTP request by generating a Message and sending it to the request channel.
protected void	onInit() Locates the MultipartResolver bean based on the default name defined by the DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME constant if available.
void	setErrorCode(java.lang.String errorCode) The error code to use to signal an error in the message handling.
void	setErrorsKey(java.lang.String errorsKey) The key used to expose Errors in the core, in the case that message handling fails.
void	setReplyKey(java.lang.String replyKey) Specify the key to be used when adding the reply Message or payload to the core map (will be payload only unless the value of HttpRequestHandlingEndpointSupport.setExtractReplyPayload(boolean) is false).
void	setViewExpression(org.springframework.expression.Expression viewExpression) Specifies a SpEL expression to evaluate in order to generate the view name.
void	setViewName(java.lang.String viewName) Specify the view name.

Methods inherited from class org.springframework.integration.http.inbound.HttpRequestHandlingEndpointSupport

afterShutdown, beforeShutdown, createEvaluationContext, doHandleRequest, doStart, getComponentType, getMessageConverters, getRequestMapping, isExpectReply, isShuttingDown, setExtractReplyPayload, setHeaderExpressions, setHeaderMapper, setMergeWithDefaultConverters, setMessageConverters, setMultipartResolver, setPath, setPayloadExpression, setRequestMapping, setRequestPayloadType, setSupportedMethods, setupResponseAndConvertReply

Methods inherited from class org.springframework.integration.gateway.MessagingGatewaySupport

doStop, receive, send, sendAndReceive, sendAndReceiveMessage, setErrorChannel, setReplyChannel, setReplyMapper, setReplyTimeout, setRequestChannel, setRequestMapper, setRequestTimeout, setShouldTrack

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

getPhase, isAutoStartup, isRunning, setAutoStartup, setPhase, setTaskScheduler, start, stop, stop

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

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

HttpRequestHandlingController

public HttpRequestHandlingController()

HttpRequestHandlingController

public HttpRequestHandlingController(boolean expectReply)

Method Detail

setViewName

public void setViewName(java.lang.String viewName)

Specify the view name.

setReplyKey

public void setReplyKey(java.lang.String replyKey)

Specify the key to be used when adding the reply Message or payload to the core map (will be payload only unless the value of HttpRequestHandlingEndpointSupport.setExtractReplyPayload(boolean) is false). The default key is "reply".

setErrorsKey

public void setErrorsKey(java.lang.String errorsKey)

The key used to expose Errors in the core, in the case that message handling fails. Defaults to "errors".

Parameters:

errorsKey - the key value to set

setErrorCode

public void setErrorCode(java.lang.String errorCode)

The error code to use to signal an error in the message handling. In the case of an error this code will be provided in an object error to be optionally translated in the standard MVC way using a MessageSource. The default value is spring.integration.http.handler.error. Three arguments are provided: the exception, its message and its stack trace as a String.

Parameters:

errorCode - the error code to set

setViewExpression

public void setViewExpression(org.springframework.expression.Expression viewExpression)

Specifies a SpEL expression to evaluate in order to generate the view name. The EvaluationContext will be populated with the reply message as the root object,

onInit

protected void onInit()
               throws java.lang.Exception

Description copied from class: HttpRequestHandlingEndpointSupport

Locates the MultipartResolver bean based on the default name defined by the DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME constant if available. Sets up default converters if no converters set, or HttpRequestHandlingEndpointSupport.setMergeWithDefaultConverters(boolean) was called with true after the converters were set.

Overrides:

onInit in class HttpRequestHandlingEndpointSupport

Throws:

java.lang.Exception

handleRequest

public final org.springframework.web.servlet.ModelAndView handleRequest(javax.servlet.http.HttpServletRequest servletRequest,
                                                         javax.servlet.http.HttpServletResponse servletResponse)
                                                                 throws java.lang.Exception

Handles the HTTP request by generating a Message and sending it to the request channel. If this gateway's 'expectReply' property is true, it will also generate a response from the reply Message once received.

Specified by:

handleRequest in interface org.springframework.web.servlet.mvc.Controller

Throws:

java.lang.Exception