spring-framework / org.springframework.web.servlet.mvc / ServletWrappingController

ServletWrappingController

open class ServletWrappingController : AbstractController, 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"> <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>

Author
Juergen Hoeller

Since
1.1.1

See Also
ServletForwardingController

Constructors

<init>

ServletWrappingController()

Functions

afterPropertiesSet

open fun afterPropertiesSet(): Unit

Initialize the wrapped Servlet instance.

destroy

open fun destroy(): Unit

Destroy the wrapped Servlet instance.

setBeanName

open fun setBeanName(name: String): Unit

setInitParameters

open fun setInitParameters(initParameters: Properties): Unit

Specify init parameters for the servlet to wrap, as name-value pairs.

setServletClass

open fun setServletClass(servletClass: Class<out Servlet>): Unit

Set the class of the servlet to wrap. Needs to implement javax.servlet.Servlet.

setServletName

open fun setServletName(servletName: String): Unit

Set the name of the servlet to wrap. Default is the bean name of this controller.