Class ServletWrappingController

java.lang.Object
org.springframework.context.support.ApplicationObjectSupport
org.springframework.web.context.support.WebApplicationObjectSupport
org.springframework.web.servlet.support.WebContentGenerator
org.springframework.web.servlet.mvc.AbstractController
org.springframework.web.servlet.mvc.ServletWrappingController
All Implemented Interfaces:
Aware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ServletContextAware, Controller
public class ServletWrappingController extends AbstractController implements BeanNameAware, InitializingBean, DisposableBean
Spring Controller implementation that wraps a servlet instance which it manages internally. Such a wrapped servlet is not known outside this controller; its entire lifecycle is covered here (in contrast to ServletForwardingController).

Useful to invoke an existing servlet via Spring's dispatching infrastructure, for example to apply Spring HandlerInterceptors to its requests.

Note that Struts has a special requirement in that it parses web.xml to find its servlet mapping. Therefore, you need to specify the DispatcherServlet's servlet name as "servletName" on this controller, so that Struts finds the DispatcherServlet's mapping (thinking that it refers to the ActionServlet).

Example: a DispatcherServlet XML context, forwarding "*.do" to the Struts ActionServlet wrapped by a ServletWrappingController. All such requests will go through the configured HandlerInterceptor chain (for example, an OpenSessionInViewInterceptor). From the Struts point of view, everything will work as usual. 

<bean id="urlMapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
  <property name="interceptors">
    <list>
      <ref bean="openSessionInViewInterceptor"/>
    </list>
  </property>
  <property name="mappings">
    <props>
      <prop key="*.do">strutsWrappingController</prop>
    </props>
  </property>
</bean>

<bean id="strutsWrappingController" class="org.springframework.web.servlet.mvc.ServletWrappingController">
  <property name="servletClass">
    <value>org.apache.struts.action.ActionServlet</value>
  </property>
  <property name="servletName">
    <value>action</value>
  </property>
  <property name="initParameters">
    <props>
      <prop key="config">/WEB-INF/struts-config.xml</prop>
    </props>
  </property>
</bean>
Since:
1.1.1
Author:
Juergen Hoeller
See Also:

  • Constructor Details

    • ServletWrappingController

      public ServletWrappingController()

  • Method Details

    • setServletClass

      public void setServletClass(Class<? extends jakarta.servlet.Servlet> servletClass)
      Set the class of the servlet to wrap. Needs to implement jakarta.servlet.Servlet.
      See Also:
      • Servlet

    • setServletName

      public void setServletName(String servletName)
      Set the name of the servlet to wrap. Default is the bean name of this controller.

    • setInitParameters

      public void setInitParameters(Properties initParameters)
      Specify init parameters for the servlet to wrap, as name-value pairs.

    • setBeanName

      public void setBeanName(String name)
      Description copied from interface: BeanNameAware
      Set the name of the bean in the bean factory that created this bean.

      Invoked after population of normal bean properties but before an init callback such as InitializingBean.afterPropertiesSet() or a custom init-method.

      Specified by:
      setBeanName in interface BeanNameAware
      Parameters:
      name - the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the BeanFactoryUtils.originalBeanName(String) method to extract the original bean name (without suffix), if desired.

    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Initialize the wrapped Servlet instance.
      Specified by:
      afterPropertiesSet in interface InitializingBean
      Throws:
      Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails for any other reason
      See Also:
      • Servlet.init(jakarta.servlet.ServletConfig)

    • handleRequestInternal

      protected @Nullable ModelAndView handleRequestInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) throws Exception
      Invoke the wrapped Servlet instance.
      Specified by:
      handleRequestInternal in class AbstractController
      Throws:
      Exception
      See Also:
      • Servlet.service(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)

    • destroy

      public void destroy()
      Destroy the wrapped Servlet instance.
      Specified by:
      destroy in interface DisposableBean
      See Also:
      • Servlet.destroy()