JstlView

Class Overview

Specialization of InternalResourceView for JSTL pages, i.e. JSP pages that use the JSP Standard Tag Library.

Exposes JSTL-specific request attributes specifying locale and resource bundle for JSTL's formatting and message tags, using Spring's locale and MessageSource.

Typical usage with InternalResourceViewResolver would look as follows, from the perspective of the DispatcherServlet context definition:

 <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
   <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
   <property name="prefix" value="/WEB-INF/jsp/"/>
   <property name="suffix" value=".jsp"/>
 </bean>

 <bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource">
   <property name="basename" value="messages"/>
 </bean>

The specified MessageSource loads messages from "messages.properties" etc files in the class path. This will automatically be exposed to views as JSTL localization context, which the JSTL fmt tags (message etc) will use. Consider using Spring's ReloadableResourceBundleMessageSource instead of the standard ResourceBundleMessageSource for more sophistication. Of course, any other Spring components can share the same MessageSource.

This is a separate class mainly to avoid JSTL dependencies in InternalResourceView itself. JSTL has not been part of standard J2EE up until J2EE 1.4, so we can't assume the JSTL API jar to be available on the class path.

Hint: Set the setExposeContextBeansAsAttributes(boolean) flag to "true" in order to make all Spring beans in the application context accessible within JSTL expressions (e.g. in a c:out value expression). This will also make all such beans accessible in plain ${...} expressions in a JSP 2.0 page.

Summary

[Expand] Inherited Constants
From class org.springframework.web.servlet.view.AbstractView String DEFAULT_CONTENT_TYPE Default content type.

[Expand] Inherited Fields
From class org.springframework.context.support.ApplicationObjectSupport protected final Log logger Logger that is available to subclasses
From interface org.springframework.web.servlet.View public static final String RESPONSE_STATUS_ATTRIBUTE Name of the HttpServletRequest attribute that contains the response status code.

[Expand] Inherited Methods
From class org.springframework.web.servlet.view.InternalResourceView void exposeForwardRequestAttributes(HttpServletRequest request) Expose the current request URI and paths as HttpServletRequest attributes under the keys defined in the Servlet 2.4 specification, for Servlet 2.3 containers as well as misbehaving Servlet 2.4 containers (such as OC4J). void exposeHelpers(HttpServletRequest request) Expose helpers unique to each rendering operation. RequestDispatcher getRequestDispatcher(HttpServletRequest request, String path) Obtain the RequestDispatcher to use for the forward/include. HttpServletRequest getRequestToExpose(HttpServletRequest originalRequest) Get the request handle to expose to the RequestDispatcher, i.e. void initServletContext(ServletContext sc) Checks whether we need to explicitly expose the Servlet 2.4 request attributes by default. boolean isContextRequired() An ApplicationContext is not strictly required for InternalResourceView. String prepareForRendering(HttpServletRequest request, HttpServletResponse response) Prepare for rendering, and determine the request dispatcher path to forward to (or to include). void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Render the internal resource given the specified model. void setAlwaysInclude(boolean alwaysInclude) Specify whether to always include the view rather than forward to it. void setExposeContextBeansAsAttributes(boolean exposeContextBeansAsAttributes) Set whether to make all Spring beans in the application context accessible as request attributes, through lazy checking once an attribute gets accessed. void setExposeForwardAttributes(boolean exposeForwardAttributes) Set whether to explictly expose the Servlet 2.4 forward request attributes when forwarding to the underlying view resource. void setExposedContextBeanNames(String[] exposedContextBeanNames) Specify the names of beans in the context which are supposed to be exposed. void setPreventDispatchLoop(boolean preventDispatchLoop) Set whether to explicitly prevent dispatching back to the current handler path. boolean useInclude(HttpServletRequest request, HttpServletResponse response) Determine whether to use RequestDispatcher's include or forward method.
From class org.springframework.web.servlet.view.AbstractUrlBasedView void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware). boolean checkResource(Locale locale) Check whether the underlying resource that the configured URL points to actually exists. String getUrl() Return the URL of the resource that this view wraps. boolean isUrlRequired() Return whether the 'url' property is required. void setUrl(String url) Set the URL of the resource that this view wraps. String toString()
From class org.springframework.web.servlet.view.AbstractView void addStaticAttribute(String name, Object value) Add static data to this view, exposed in each view. RequestContext createRequestContext(HttpServletRequest request, HttpServletResponse response, Map<String, Object> model) Create a RequestContext to expose under the specified attribute name. ByteArrayOutputStream createTemporaryOutputStream() Create a temporary OutputStream for this view. void exposeModelAsRequestAttributes(Map<String, Object> model, HttpServletRequest request) Expose the model objects in the given map as request attributes. boolean generatesDownloadContent() Return whether this view generates download content (typically binary content like PDF or Excel files). Map<String, Object> getAttributesMap() Allow Map access to the static attributes of this view, with the option to add or override specific entries. String getBeanName() Return the view's name. String getContentType() Return the content type for this view. String getRequestContextAttribute() Return the name of the RequestContext attribute, if any. Map getStaticAttributes() Return the static attributes for this view. void prepareResponse(HttpServletRequest request, HttpServletResponse response) Prepare the given response for rendering. void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Prepares the view given the specified model, merging it with static attributes and a RequestContext attribute, if necessary. abstract void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view. void setAttributes(Properties attributes) Set static attributes for this view from a java.util.Properties object. void setAttributesCSV(String propString) Set static attributes as a CSV string. void setAttributesMap(Map<String, ?> attributes) Set static attributes for this view from a Map. void setBeanName(String beanName) Set the view's name. void setContentType(String contentType) Set the content type for this view. void setRequestContextAttribute(String requestContextAttribute) Set the name of the RequestContext attribute for this view. String toString() void writeToResponse(HttpServletResponse response, ByteArrayOutputStream baos) Write the given temporary OutputStream to the HTTP response.
From class org.springframework.web.context.support.WebApplicationObjectSupport 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. final void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From class org.springframework.context.support.ApplicationObjectSupport final ApplicationContext getApplicationContext() Return the ApplicationContext that this object is associated with. 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. final void setApplicationContext(ApplicationContext context) Set the ApplicationContext that this object runs in.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.factory.BeanNameAware abstract void setBeanName(String name) Set the name of the bean in the bean factory that created this bean.
From interface org.springframework.beans.factory.InitializingBean abstract void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
From interface org.springframework.context.ApplicationContextAware abstract void setApplicationContext(ApplicationContext applicationContext) Set the ApplicationContext that this object runs in.
From interface org.springframework.web.context.ServletContextAware abstract void setServletContext(ServletContext servletContext) Set the ServletContext that this object runs in.
From interface org.springframework.web.servlet.View abstract String getContentType() Return the content type of the view, if predetermined. abstract void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Render the view given the specified model.