Spring Framework

Class ServletWrappingController

  extended by org.springframework.context.support.ApplicationObjectSupport
      extended by org.springframework.web.context.support.WebApplicationObjectSupport
          extended by org.springframework.web.servlet.support.WebContentGenerator
              extended by org.springframework.web.servlet.mvc.AbstractController
                  extended by 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 of 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 (e.g. 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">
       <ref bean="openSessionInViewInterceptor"/>
   <property name="mappings">
       <prop key="*.do">strutsWrappingController</prop>

 <bean id="strutsWrappingController" class="org.springframework.web.servlet.mvc.ServletWrappingController">
   <property name="servletClass">
   <property name="servletName">
   <property name="initParameters">
       <prop key="config">/WEB-INF/struts-config.xml</prop>

Juergen Hoeller
See Also:
ServletForwardingController, OpenSessionInViewInterceptor, OpenSessionInViewFilter, OpenPersistenceManagerInViewInterceptor, OpenPersistenceManagerInViewFilter

Field Summary
Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
Constructor Summary
Method Summary
 void afterPropertiesSet()
          Initialize the wrapped Servlet instance.
 void destroy()
          Destroy the wrapped Servlet instance.
protected  ModelAndView handleRequestInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Invoke the the wrapped Servlet instance.
 void setBeanName(java.lang.String name)
          Set the name of the bean in the bean factory that created this bean.
 void setInitParameters(java.util.Properties initParameters)
          Specify init parameters for the servlet to wrap, as name-value pairs.
 void setServletClass(java.lang.Class servletClass)
          Set the class of the servlet to wrap.
 void setServletName(java.lang.String servletName)
          Set the name of the servlet to wrap.
Methods inherited from class org.springframework.web.servlet.mvc.AbstractController
handleRequest, isSynchronizeOnSession, setSynchronizeOnSession
Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator
applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public ServletWrappingController()
Method Detail


public void setServletClass(java.lang.Class servletClass)
Set the class of the servlet to wrap. Needs to implement javax.servlet.Servlet.

See Also:


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


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


public void setBeanName(java.lang.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
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.


public void afterPropertiesSet()
                        throws java.lang.Exception
Initialize the wrapped Servlet instance.

Specified by:
afterPropertiesSet in interface InitializingBean
java.lang.Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails.
See Also:


protected ModelAndView handleRequestInternal(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                      throws java.lang.Exception
Invoke the the wrapped Servlet instance.

Specified by:
handleRequestInternal in class AbstractController
See Also:
Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)


public void destroy()
Destroy the wrapped Servlet instance.

Specified by:
destroy in interface DisposableBean
See Also:

Spring Framework