org.springframework.web.servlet
Class FrameworkServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.springframework.web.servlet.HttpServletBean
              org.springframework.web.servlet.FrameworkServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

Direct Known Subclasses:

DispatcherServlet

public abstract class FrameworkServlet

extends HttpServletBean

Base servlet for servlets within the web framework. Allows integration with an application context, in a JavaBean-based overall solution.

This class offers the following functionality:

• Uses a WebApplicationContext to access a BeanFactory. The servlet's configuration is determined by beans in the servlet's namespace.
• Publishes events on request processing, whether or not a request is successfully handled.

Subclasses must implement doService() to handle requests. Because this extends HttpServletBean rather than HttpServlet directly, bean properties are mapped onto it. Subclasses can override initFrameworkServlet() for custom initialization.

Regards a "contextClass" parameter at the servlet init-param level, falling back to the default context class (XmlWebApplicationContext) if not found. With the default FrameworkServlet, a context class needs to implement ConfigurableWebApplicationContext.

Passes a "contextConfigLocation" servlet init-param to the context instance, parsing it into potentially multiple file paths which can be separated by any number of commas and spaces, like "test-servlet.xml, myServlet.xml". If not explicitly specified, the context implementation is supposed to build a default location from the namespace of the servlet.

Note: In case of multiple config locations, later bean definitions will override ones defined in earlier loaded files, at least when using one of Spring's default ApplicationContext implementations. This can be leveraged to deliberately override certain bean definitions via an extra XML file.

The default namespace is "'servlet-name'-servlet", e.g. "test-servlet" for a servlet-name "test" (leading to a "/WEB-INF/test-servlet.xml" default location with XmlWebApplicationContext). The namespace can also be set explicitly via the "namespace" servlet init-param.

Author:

Rod Johnson, Juergen Hoeller

See Also:

doService(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse), initFrameworkServlet(), setContextClass(java.lang.Class), setContextConfigLocation(java.lang.String), setNamespace(java.lang.String), Serialized Form

Field Summary

static Class	DEFAULT_CONTEXT_CLASS Default context class for FrameworkServlet.
static String	DEFAULT_NAMESPACE_SUFFIX Suffix for WebApplicationContext namespaces.
static String	SERVLET_CONTEXT_PREFIX Prefix for the ServletContext attribute for the WebApplicationContext.

Fields inherited from class org.springframework.web.servlet.HttpServletBean

logger

Constructor Summary

FrameworkServlet()

Method Summary

protected WebApplicationContext	createWebApplicationContext(WebApplicationContext parent) Instantiate the WebApplicationContext for this servlet, either a default XmlWebApplicationContext or a custom context class if set.
void	destroy() Close the WebApplicationContext of this servlet.
protected void	doDelete(HttpServletRequest request, HttpServletResponse response) Delegate DELETE requests to servletWrapper respectively doService.
protected void	doGet(HttpServletRequest request, HttpServletResponse response) Delegate GET requests to servletWrapper respectively doService.
protected void	doHead(HttpServletRequest request, HttpServletResponse response) Delegate HEAD requests to servletWrapper respectively doService.
protected void	doPost(HttpServletRequest request, HttpServletResponse response) Delegate POST requests to servletWrapper respectively doService.
protected void	doPut(HttpServletRequest request, HttpServletResponse response) Delegate PUT requests to servletWrapper respectively doService.
protected abstract void	doService(HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to do the work of request handling.
Class	getContextClass() Return the custom context class.
String	getContextConfigLocation() Return the explicit context config location, if any.
String	getNamespace() Return the namespace for this servlet, falling back to default scheme if no custom namespace was set: e.g.
String	getServletContextAttributeName() Return the ServletContext attribute name for this servlet's WebApplicationContext.
protected String	getUsernameForRequest(HttpServletRequest request) Determine the username for the given request.
WebApplicationContext	getWebApplicationContext() Return this servlet's WebApplicationContext.
protected void	initFrameworkServlet() This method will be invoked after any bean properties have been set and the WebApplicationContext has been loaded.
protected void	initServletBean() Overridden method of HttpServletBean, invoked after any bean properties have been set.
protected WebApplicationContext	initWebApplicationContext() Initialize and publish the WebApplicationContext for this servlet.
boolean	isPublishContext() Return whether to publish this servlet's context as a ServletContext attribute.
boolean	isPublishEvents() Return whether this servlet should publish a RequestHandlerEvent at the end of each request.
void	setContextClass(Class contextClass) Set a custom context class.
void	setContextConfigLocation(String contextConfigLocation) Set the context config location explicitly, instead of relying on the default location built from the namespace.
void	setNamespace(String namespace) Set a custom namespace for this servlet, to be used for building a default context config location.
void	setPublishContext(boolean publishContext) Set whether to publish this servlet's context as a ServletContext attribute, available to all objects in the web container.
void	setPublishEvents(boolean publishEvents) Set whether this servlet should publish a RequestHandlerEvent at the end of each request.

Methods inherited from class org.springframework.web.servlet.HttpServletBean

addRequiredProperty, init, initBeanWrapper

Methods inherited from class javax.servlet.http.HttpServlet

doOptions, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_NAMESPACE_SUFFIX

public static final String DEFAULT_NAMESPACE_SUFFIX

Suffix for WebApplicationContext namespaces. If a servlet of this class is given the name "test" in a context, the namespace used by the servlet will resolve to "test-servlet".

See Also:

Constant Field Values

DEFAULT_CONTEXT_CLASS

public static final Class DEFAULT_CONTEXT_CLASS

Default context class for FrameworkServlet.

See Also:

XmlWebApplicationContext

SERVLET_CONTEXT_PREFIX

public static final String SERVLET_CONTEXT_PREFIX

Prefix for the ServletContext attribute for the WebApplicationContext. The completion is the servlet name.

Constructor Detail

FrameworkServlet

public FrameworkServlet()

Method Detail

setContextClass

public void setContextClass(Class contextClass)

Set a custom context class. This class must be of type WebApplicationContext; when using the default FrameworkServlet implementation, the context class must also implement ConfigurableWebApplicationContext.

See Also:

createWebApplicationContext(org.springframework.web.context.WebApplicationContext)

getContextClass

public Class getContextClass()

Return the custom context class.

setNamespace

public void setNamespace(String namespace)

Set a custom namespace for this servlet, to be used for building a default context config location.

getNamespace

public String getNamespace()

Return the namespace for this servlet, falling back to default scheme if no custom namespace was set: e.g. "test-servlet" for a servlet named "test".

setContextConfigLocation

public void setContextConfigLocation(String contextConfigLocation)

Set the context config location explicitly, instead of relying on the default location built from the namespace. This location string can consist of multiple locations separated by any number of commas and spaces.

getContextConfigLocation

public String getContextConfigLocation()

Return the explicit context config location, if any.

setPublishContext

public void setPublishContext(boolean publishContext)

Set whether to publish this servlet's context as a ServletContext attribute, available to all objects in the web container. Default is true.

This is especially handy during testing, although it is debatable whether it's good practice to let other application objects access the context this way.

isPublishContext

public boolean isPublishContext()

Return whether to publish this servlet's context as a ServletContext attribute.

setPublishEvents

public void setPublishEvents(boolean publishEvents)

Set whether this servlet should publish a RequestHandlerEvent at the end of each request. Default is true; can be turned off for a slight performance improvement, provided that no ApplicationListeners rely on such events.

isPublishEvents

public boolean isPublishEvents()

Return whether this servlet should publish a RequestHandlerEvent at the end of each request.

initServletBean

protected final void initServletBean()
                              throws ServletException,
                                     BeansException

Overridden method of HttpServletBean, invoked after any bean properties have been set. Creates this servlet's WebApplicationContext.

Overrides:

initServletBean in class HttpServletBean

Throws:

ServletException - if subclass initialization fails

BeansException

initWebApplicationContext

protected WebApplicationContext initWebApplicationContext()
                                                   throws BeansException

Initialize and publish the WebApplicationContext for this servlet. Delegates to createWebApplicationContext for actual creation. Can be overridden in subclasses.

Throws:

BeansException - if the context couldn't be initialized

See Also:

createWebApplicationContext(org.springframework.web.context.WebApplicationContext)

createWebApplicationContext

protected WebApplicationContext createWebApplicationContext(WebApplicationContext parent)
                                                     throws BeansException

Instantiate the WebApplicationContext for this servlet, either a default XmlWebApplicationContext or a custom context class if set. This implementation expects custom contexts to implement ConfigurableWebApplicationContext. Can be overridden in subclasses.

Throws:

BeansException - if the context couldn't be initialized

See Also:

setContextClass(java.lang.Class), XmlWebApplicationContext

getServletContextAttributeName

public String getServletContextAttributeName()

Return the ServletContext attribute name for this servlet's WebApplicationContext. Default implementation returns SERVLET_CONTEXT_PREFIX + servlet name.

See Also:

SERVLET_CONTEXT_PREFIX, GenericServlet.getServletName()

getWebApplicationContext

public final WebApplicationContext getWebApplicationContext()

Return this servlet's WebApplicationContext.

initFrameworkServlet

protected void initFrameworkServlet()
                             throws ServletException,
                                    BeansException

This method will be invoked after any bean properties have been set and the WebApplicationContext has been loaded. The default implementation is empty; subclasses may override this method to perform any initialization they require.

Throws:

ServletException - in case of an initialization exception

BeansException - if thrown by ApplicationContext methods

doGet

protected final void doGet(HttpServletRequest request,
                           HttpServletResponse response)
                    throws ServletException,
                           IOException

Delegate GET requests to servletWrapper respectively doService.

Throws:

ServletException

IOException

See Also:

doService(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doPost

protected final void doPost(HttpServletRequest request,
                            HttpServletResponse response)
                     throws ServletException,
                            IOException

Delegate POST requests to servletWrapper respectively doService.

Throws:

ServletException

IOException

See Also:

doService(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doPut

protected final void doPut(HttpServletRequest request,
                           HttpServletResponse response)
                    throws ServletException,
                           IOException

Delegate PUT requests to servletWrapper respectively doService.

Throws:

ServletException

IOException

See Also:

doService(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doDelete

protected final void doDelete(HttpServletRequest request,
                              HttpServletResponse response)
                       throws ServletException,
                              IOException

Delegate DELETE requests to servletWrapper respectively doService.

Throws:

ServletException

IOException

See Also:

doService(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doHead

protected final void doHead(HttpServletRequest request,
                            HttpServletResponse response)
                     throws ServletException,
                            IOException

Delegate HEAD requests to servletWrapper respectively doService.

Throws:

ServletException

IOException

See Also:

doService(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getUsernameForRequest

protected String getUsernameForRequest(HttpServletRequest request)

Determine the username for the given request. Default implementation takes the name of the UserPrincipal, if any. Can be overridden in subclasses.

Parameters:

request - current HTTP request

Returns:

the username, or null if none

See Also:

HttpServletRequest.getUserPrincipal()

doService

protected abstract void doService(HttpServletRequest request,
                                  HttpServletResponse response)
                           throws Exception

Subclasses must implement this method to do the work of request handling. The contract is the same as that for the doGet or doPost methods of HttpServlet. This class intercepts calls to ensure that event publication takes place.

Parameters:

request - current HTTP request

response - current HTTP response

Throws:

Exception - in case of any kind of processing failure

See Also:

HttpServlet.doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse), HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

destroy

public void destroy()

Close the WebApplicationContext of this servlet.

See Also:

ConfigurableApplicationContext.close()