public abstract class

ApplicationObjectSupport

extends Object
implements ApplicationContextAware

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

Known Direct Subclasses

AbstractHandlerMapping, PortletApplicationObjectSupport, WebApplicationObjectSupport

Known Indirect Subclasses

AbstractAtomFeedView, AbstractCachingViewResolver, AbstractCommandController, AbstractController, AbstractControllerUrlHandlerMapping, AbstractDetectingUrlHandlerMapping, AbstractExcelView, AbstractFeedView<T extends WireFeed>, AbstractFormController, AbstractHandlerMapping, AbstractJExcelView, AbstractJasperReportsSingleFormatView, AbstractJasperReportsView, AbstractMapBasedHandlerMapping<K>, AbstractPdfStamperView, and 63 others.

AbstractAtomFeedView	Abstract superclass for Atom Feed views, using java.net's ROME package.
AbstractCachingViewResolver	Convenient base class for `ViewResolver` implementations.
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
AbstractHandlerMapping	Abstract base class for `HandlerMapping` implementations.
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.
AbstractMapBasedHandlerMapping<K>	Abstract base class for `HandlerMapping` implementations that rely on a map which caches handler objects per lookup key.
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.
AbstractView	Abstract base class for `View` implementations.
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.
BeanNameViewResolver	Simple implementation of ViewResolver that interprets a view name as bean name in the current application context, i.e.
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.
ContentNegotiatingViewResolver	Implementation of `ViewResolver` that resolves a view based on the request file name or `Accept` header.
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.
ParameterHandlerMapping	Implementation of the `HandlerMapping` to map from a request parameter to request handler beans.
ParameterizableViewController	Trivial controller that always returns a named view.
PortletContentGenerator	Convenient superclass for any kind of web content generator, like `AbstractController`.
PortletModeHandlerMapping	Implementation of the `HandlerMapping` interface to map from the current PortletMode to request handler beans.
PortletModeParameterHandlerMapping	Implementation of the `HandlerMapping` interface to map from the current PortletMode and a request parameter to request handler beans.
PortletWrappingController	`Controller` implementation that wraps a portlet instance which it manages internally.
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.
TilesConfigurer	This class is deprecated. as of Spring 3.0
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.
WebContentGenerator	Convenient superclass for any kind of web content generator, like `AbstractController` and `WebContentInterceptor`.
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 that want to be aware of the application context, e.g. for custom lookup of collaborating beans or for context-specific resource access. It saves the application context reference and provides an initialization callback method. Furthermore, it offers numerous convenience methods for message lookup.

There is no requirement to subclass this class: It just makes things a little easier if you need access to the context, e.g. for access to file resources or to the message source. Note that many application objects do not need to be aware of the application context at all, as they can receive collaborating beans via bean references.

Many framework classes are derived from this class, particularly within the web support.

Summary

Fields
protected final Log	logger	Logger that is available to subclasses

Public Constructors
	ApplicationObjectSupport()

Public Methods
final ApplicationContext	getApplicationContext() Return the ApplicationContext that this object is associated with.
final void	setApplicationContext(ApplicationContext context) Set the ApplicationContext that this object runs in.

Protected Methods
final MessageSourceAccessor	getMessageSourceAccessor() Return a MessageSourceAccessor for the application context used by this object, for easy message access.
void	initApplicationContext() Subclasses can override this for custom initialization behavior.
void	initApplicationContext(ApplicationContext context) Subclasses can override this for custom initialization behavior.
boolean	isContextRequired() Determine whether this application object needs to run in an ApplicationContext.
Class	requiredContextClass() Determine the context class that any context passed to `setApplicationContext` must be an instance of.

[Expand]

Inherited Methods

From class java.lang.Object

From interface org.springframework.context.ApplicationContextAware

Fields

protected final Log logger

Logger that is available to subclasses

Public Constructors

public ApplicationObjectSupport ()

Public Methods

public final ApplicationContext getApplicationContext ()

Return the ApplicationContext that this object is associated with.

Throws

IllegalStateException	if not running in an ApplicationContext

public final void setApplicationContext (ApplicationContext context)

Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.

Invoked after population of normal bean properties but before an init callback such as afterPropertiesSet() or a custom init-method. Invoked after setResourceLoader(ResourceLoader), setApplicationEventPublisher(ApplicationEventPublisher) and MessageSourceAware, if applicable.

Parameters

context	the ApplicationContext object to be used by this object

Throws

BeansException

Protected Methods

protected final MessageSourceAccessor getMessageSourceAccessor ()

Return a MessageSourceAccessor for the application context used by this object, for easy message access.

Throws

IllegalStateException	if not running in an ApplicationContext

protected void initApplicationContext ()

Subclasses can override this for custom initialization behavior.

The default implementation is empty. Called by initApplicationContext(org.springframework.context.ApplicationContext).

Throws

ApplicationContextException	in case of initialization errors
BeansException	if thrown by ApplicationContext methods

protected void initApplicationContext (ApplicationContext context)

Subclasses can override this for custom initialization behavior. Gets called by setApplicationContext after setting the context instance.

Note: Does not get called on reinitialization of the context but rather just on first initialization of this object's context reference.

The default implementation calls the overloaded initApplicationContext() method without ApplicationContext reference.

Parameters

context	the containing ApplicationContext

Throws

ApplicationContextException	in case of initialization errors
BeansException	if thrown by ApplicationContext methods

protected boolean isContextRequired ()

Determine whether this application object needs to run in an ApplicationContext.

Default is "false". Can be overridden to enforce running in a context (i.e. to throw IllegalStateException on accessors if outside a context).

protected Class requiredContextClass ()

Determine the context class that any context passed to setApplicationContext must be an instance of. Can be overridden in subclasses.

Classes

ApplicationObjectSupport

Class Overview

See Also

Summary

Fields

protected final Log logger

Public Constructors

public ApplicationObjectSupport ()

Public Methods

public final ApplicationContext getApplicationContext ()

Throws

public final void setApplicationContext (ApplicationContext context)

Parameters

Throws

Protected Methods

protected final MessageSourceAccessor getMessageSourceAccessor ()

Throws

protected void initApplicationContext ()

Throws

See Also

protected void initApplicationContext (ApplicationContext context)

Parameters

Throws

See Also

protected boolean isContextRequired ()

See Also

protected Class requiredContextClass ()

See Also