Package 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.BaseHttpInboundEndpoint
org.springframework.integration.http.inbound.HttpRequestHandlingEndpointSupport
org.springframework.integration.http.inbound.HttpRequestHandlingController
All Implemented Interfaces:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, OrderlyShutdownCapable, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent, Controller
public class HttpRequestHandlingController extends HttpRequestHandlingEndpointSupport implements 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 BaseHttpInboundEndpoint.setExtractReplyPayload(boolean) (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, Artem Bilan

  • Field Details

  • Constructor Details

    • HttpRequestHandlingController

      public HttpRequestHandlingController()

    • HttpRequestHandlingController

      public HttpRequestHandlingController(boolean expectReply)

  • Method Details

    • setViewName

      public void setViewName(String viewName)
      Specify the view name.
      Parameters:
      viewName - The view name.

    • setReplyKey

      public void setReplyKey(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 BaseHttpInboundEndpoint.setExtractReplyPayload(boolean) is false). The default key is "reply".
      Parameters:
      replyKey - The reply key.

    • setErrorsKey

      public void setErrorsKey(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(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(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,
      Parameters:
      viewExpression - The view expression.

    • onInit

      protected void onInit()
      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

    • handleRequest

      public final ModelAndView handleRequest(HttpServletRequest servletRequest, HttpServletResponse servletResponse)
      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 Controller