public abstract class

WebApplicationObjectSupport

extends ApplicationObjectSupport
implements ServletContextAware

java.lang.Object
↳	org.springframework.context.support.ApplicationObjectSupport
	↳	org.springframework.web.context.support.WebApplicationObjectSupport

Known Direct Subclasses

AbstractCachingViewResolver, AbstractHandlerMapping, AbstractView, BeanNameViewResolver, ContentNegotiatingViewResolver, TilesConfigurer, WebContentGenerator

Known Indirect Subclasses

AbstractAtomFeedView, AbstractCommandController, AbstractController, AbstractControllerUrlHandlerMapping, AbstractDetectingUrlHandlerMapping, AbstractExcelView, AbstractFeedView<T extends WireFeed>, AbstractFormController, AbstractJExcelView, AbstractJasperReportsSingleFormatView, AbstractJasperReportsView, AbstractPdfStamperView, AbstractPdfView, AbstractRssFeedView, AbstractTemplateView, and 50 others.

AbstractAtomFeedView	Abstract superclass for Atom Feed views, using java.net's ROME package.
AbstractCommandController	This class is deprecated. as of Spring 3.0, in favor of annotated controllers
AbstractController	Convenient superclass for controller implementations, using the Template Method design pattern.
AbstractControllerUrlHandlerMapping	Base class for `HandlerMapping` implementations that derive URL paths according to conventions for specific controller types.
AbstractDetectingUrlHandlerMapping	Abstract implementation of the `HandlerMapping` interface, detecting URL mappings for handler beans through introspection of all defined beans in the application context.
AbstractExcelView	Convenient superclass for Excel document views.
AbstractFeedView<T extends WireFeed>	Abstract base class for Atom and RSS Feed views, using java.net's ROME package.
AbstractFormController	This class is deprecated. as of Spring 3.0, in favor of annotated controllers
AbstractJExcelView	Convenient superclass for Excel document views.
AbstractJasperReportsSingleFormatView	Extends `AbstractJasperReportsView` to provide basic rendering logic for views that use a fixed format, e.g.
AbstractJasperReportsView	Base class for all JasperReports views.
AbstractPdfStamperView	Abstract superclass for PDF views that operate on an existing document with an AcroForm.
AbstractPdfView	Abstract superclass for PDF views, using Bruno Lowagie's iText package.
AbstractRssFeedView	Abstract superclass for RSS Feed views, using java.net's ROME package.
AbstractTemplateView	Adapter base class for template-based view technologies such as Velocity and FreeMarker, with the ability to use request and session attributes in their model and the option to expose helper objects for Spring's Velocity/FreeMarker macro library.
AbstractTemplateViewResolver	Abstract base class for template view resolvers, in particular for Velocity and FreeMarker views.
AbstractUrlBasedView	Abstract base class for URL-based views.
AbstractUrlHandlerMapping	Abstract base class for URL-mapped `HandlerMapping` implementations.
AbstractUrlViewController	Abstract base class for `Controllers` that return a view name based on the request URL.
AbstractWizardFormController	This class is deprecated. as of Spring 3.0, in favor of annotated controllers
AbstractXsltView	This class is deprecated. since Spring 2.5; superseded by `XsltView` and its more flexible `locateSource(Map)` mechanism
AnnotationMethodHandlerAdapter	Implementation of the `HandlerAdapter` interface that maps handler methods based on HTTP paths, HTTP methods and request parameters expressed through the `RequestMapping` annotation.
BaseCommandController	This class is deprecated. as of Spring 3.0, in favor of annotated controllers
BeanNameUrlHandlerMapping	Implementation of the `HandlerMapping` interface that map from URLs to beans with names that start with a slash ("/"), similar to how Struts maps URLs to action names.
CancellableFormController	This class is deprecated. as of Spring 3.0, in favor of annotated controllers
ConfigurableJasperReportsView	Configurable JasperReports View, allowing to specify the JasperReports exporter to be specified through bean properties rather than through the view class name.
ControllerBeanNameHandlerMapping	Implementation of `HandlerMapping` that follows a simple convention for generating URL path mappings from the bean names of registered `Controller` beans as well as `@Controller` annotated beans.
ControllerClassNameHandlerMapping	Implementation of `HandlerMapping` that follows a simple convention for generating URL path mappings from the class names of registered `Controller` beans as well as `@Controller` annotated beans.
DefaultAnnotationHandlerMapping	Implementation of the `HandlerMapping` interface that maps handlers based on HTTP paths expressed through the `RequestMapping` annotation at the type or method level.
FreeMarkerView	View using the FreeMarker template engine.
FreeMarkerViewResolver	Convenience subclass of `UrlBasedViewResolver` that supports `FreeMarkerView` (i.e.
InternalResourceView	Wrapper for a JSP or other resource within the same web application.
InternalResourceViewResolver	Convenient subclass of `UrlBasedViewResolver` that supports `InternalResourceView` (i.e.
JasperReportsCsvView	Implementation of `AbstractJasperReportsSingleFormatView` that renders report results in CSV format.
JasperReportsHtmlView	Implementation of `AbstractJasperReportsSingleFormatView` that renders report results in HTML format.
JasperReportsMultiFormatView	Jasper Reports view class that allows for the actual rendering format to be specified at runtime using a parameter contained in the model.
JasperReportsPdfView	Implementation of `AbstractJasperReportsSingleFormatView` that renders report results in PDF format.
JasperReportsViewResolver	`ViewResolver` implementation that resolves instances of `AbstractJasperReportsView` by translating the supplied view name into the URL of the report file.
JasperReportsXlsView	Implementation of `AbstractJasperReportsSingleFormatView` that renders report results in XLS format.
JstlView	Specialization of `InternalResourceView` for JSTL pages, i.e.
MappingJacksonJsonView	Spring-MVC `View` that renders JSON content by serializing the model for the current request using Jackson's ObjectMapper.
MarshallingView	Spring-MVC `View` that allows for response context to be rendered as the result of marshalling by a `Marshaller`.
MultiActionController	`Controller` implementation that allows multiple request types to be handled by the same class.
ParameterizableViewController	Trivial controller that always returns a named view.
RedirectView	View that redirects to an absolute, context relative, or current request relative URL.
ResourceBundleViewResolver	`ViewResolver` implementation that uses bean definitions in a ResourceBundle, specified by the bundle basename.
ResourceHttpRequestHandler	`HttpRequestHandler` that serves static resources optimized for superior browser performance (according to the guidelines of Page Speed, YSlow, etc.) by allowing for flexible cache settings (`"cacheSeconds" property`, last-modified support).
ServletForwardingController	Spring Controller implementation that forwards to a named servlet, i.e.
ServletWrappingController	Spring Controller implementation that wraps a servlet instance which it manages internally.
SimpleFormController	This class is deprecated. as of Spring 3.0, in favor of annotated controllers
SimpleUrlHandlerMapping	Implementation of the `HandlerMapping` interface to map from URLs to request handler beans.
TilesJstlView	This class is deprecated. as of Spring 3.0
TilesView	This class is deprecated. as of Spring 3.0
TilesViewResolver	Convenience subclass of `UrlBasedViewResolver` that supports `TilesView` (i.e.
UrlBasedViewResolver	Simple implementation of the `ViewResolver` interface, allowing for direct resolution of symbolic view names to URLs, without explicit mapping definition.
UrlFilenameViewController	Simple `Controller` implementation that transforms the virtual path of a URL into a view name and returns that view.
VelocityLayoutView	VelocityLayoutView emulates the functionality offered by Velocity's VelocityLayoutServlet to ease page composition from different templates.
VelocityLayoutViewResolver	Convenience subclass of VelocityViewResolver, adding support for VelocityLayoutView and its properties.
VelocityToolboxView	`VelocityView` subclass which adds support for Velocity Tools toolboxes and Velocity Tools ViewTool callbacks / Velocity Tools 1.3 init methods.
VelocityView	View using the Velocity template engine.
VelocityViewResolver	Convenience subclass of `UrlBasedViewResolver` that supports `VelocityView` (i.e.
WebContentInterceptor	Interceptor that checks and prepares request and response.
XmlViewResolver	Implementation of ViewResolver that uses bean definitions in an XML file, specified by resource location.
XsltView	XSLT-driven View that allows for response context to be rendered as the result of an XSLT transformation.
XsltViewResolver	`ViewResolver` implementation that resolves instances of `XsltView` by translating the supplied view name into the URL of the XSLT stylesheet.

Class Overview

Convenient superclass for application objects running in a WebApplicationContext. Provides getWebApplicationContext(), getServletContext(), and getTempDir() methods.

Summary

[Expand]

Inherited Fields

From class org.springframework.context.support.ApplicationObjectSupport

Public Constructors
	WebApplicationObjectSupport()

Public Methods
final void	setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.

Protected Methods
final ServletContext	getServletContext() Return the current ServletContext.
final File	getTempDir() Return the temporary directory for the current web application, as provided by the servlet container.
final WebApplicationContext	getWebApplicationContext() Return the current application context as WebApplicationContext.
void	initApplicationContext(ApplicationContext context) Calls `initServletContext(javax.servlet.ServletContext)` if the given ApplicationContext is a `WebApplicationContext`.
void	initServletContext(ServletContext servletContext) Subclasses may override this for custom initialization based on the ServletContext that this application object runs in.
boolean	isContextRequired() Overrides the base class behavior to enforce running in an ApplicationContext.

[Expand]

Inherited Methods

From class org.springframework.context.support.ApplicationObjectSupport

From class java.lang.Object

From interface org.springframework.context.ApplicationContextAware

From interface org.springframework.web.context.ServletContextAware

Public Constructors

public WebApplicationObjectSupport ()

Public Methods

public final void setServletContext (ServletContext servletContext)

Set the ServletContext that this object runs in.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.

Parameters

servletContext	ServletContext object to be used by this object

Protected Methods

protected final ServletContext getServletContext ()

Return the current ServletContext.

Throws

IllegalStateException	if not running within a ServletContext

protected final File getTempDir ()

Return the temporary directory for the current web application, as provided by the servlet container.

Returns

the File representing the temporary directory

Throws

IllegalStateException	if not running within a ServletContext

protected final WebApplicationContext getWebApplicationContext ()

Return the current application context as WebApplicationContext.

NOTE: Only use this if you actually need to access WebApplicationContext-specific functionality. Preferably use getApplicationContext() or getServletContext() else, to be able to run in non-WebApplicationContext environments as well.

Throws

IllegalStateException	if not running in a WebApplicationContext

protected void initApplicationContext (ApplicationContext context)

Calls initServletContext(javax.servlet.ServletContext) if the given ApplicationContext is a WebApplicationContext.

Parameters

context	the containing ApplicationContext

protected void initServletContext (ServletContext servletContext)

Subclasses may override this for custom initialization based on the ServletContext that this application object runs in.

The default implementation is empty. Called by initApplicationContext(org.springframework.context.ApplicationContext) as well as setServletContext(javax.servlet.ServletContext).

Parameters

servletContext	the ServletContext that this application object runs in (never `null`)

protected boolean isContextRequired ()

Overrides the base class behavior to enforce running in an ApplicationContext. All accessors will throw IllegalStateException if not running in a context.

Classes

WebApplicationObjectSupport

Class Overview

See Also

Summary

Public Constructors

public WebApplicationObjectSupport ()

Public Methods

public final void setServletContext (ServletContext servletContext)

Parameters

Protected Methods

protected final ServletContext getServletContext ()

Throws

protected final File getTempDir ()

Returns

Throws

See Also

protected final WebApplicationContext getWebApplicationContext ()

Throws

See Also

protected void initApplicationContext (ApplicationContext context)

Parameters

protected void initServletContext (ServletContext servletContext)

Parameters

protected boolean isContextRequired ()

See Also