Class InternalResourceViewResolver

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractCachingViewResolver

org.springframework.web.servlet.view.UrlBasedViewResolver

org.springframework.web.servlet.view.InternalResourceViewResolver

All Implemented Interfaces:

Aware, ApplicationContextAware, Ordered, ServletContextAware, ViewResolver

public class InternalResourceViewResolver
extends UrlBasedViewResolver

Convenient subclass of UrlBasedViewResolver that supports InternalResourceView (i.e. Servlets and JSPs) and subclasses such as JstlView.

The view class for all views generated by this resolver can be specified via UrlBasedViewResolver.setViewClass(Class). See UrlBasedViewResolver's javadoc for details. The default is InternalResourceView, or JstlView if the JSTL API is present.

BTW, it's good practice to put JSP files that just serve as views under WEB-INF, to hide them from direct access (for example, via a manually entered URL). Only controllers will be able to access them then.

Note: When chaining ViewResolvers, an InternalResourceViewResolver always needs to be last, as it will attempt to resolve any view name, no matter whether the underlying resource actually exists.

Since:

17.02.2003

Author:

Juergen Hoeller

See Also:

• UrlBasedViewResolver.setViewClass(Class)
• UrlBasedViewResolver.setPrefix(String)
• UrlBasedViewResolver.setSuffix(String)
• UrlBasedViewResolver.setRequestContextAttribute(String)
• InternalResourceView
• JstlView

Nested Class Summary

Nested classes/interfaces inherited from class AbstractCachingViewResolver

AbstractCachingViewResolver.CacheFilter

Field Summary

Fields inherited from class UrlBasedViewResolver

FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

Fields inherited from class AbstractCachingViewResolver

DEFAULT_CACHE_LIMIT

Fields inherited from class ApplicationObjectSupport

logger

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
InternalResourceViewResolver()	Sets the default view class to requiredViewClass(): by default InternalResourceView, or JstlView if the JSTL API is present.
InternalResourceViewResolver(String prefix, String suffix)	A convenience constructor that allows for specifying prefix and suffix as constructor arguments.

Method Summary

Modifier and Type	Method	Description
protected AbstractUrlBasedView	buildView(String viewName)	Creates a new View instance of the specified view class and configures it.
protected AbstractUrlBasedView	instantiateView()	Instantiate the specified view class.
protected Class<?>	requiredViewClass()	Return the required type of view for this resolver.
void	setAlwaysInclude(boolean alwaysInclude)	Specify whether to always include the view rather than forward to it.

Methods inherited from class UrlBasedViewResolver

applyLifecycleMethods, canHandle, createView, getAttributesMap, getCacheKey, getContentType, getExposeContextBeansAsAttributes, getExposedContextBeanNames, getExposePathVariables, getOrder, getPrefix, getRedirectHosts, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, setAttributes, setAttributesMap, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setOrder, setPrefix, setRedirectContextRelative, setRedirectHosts, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

Methods inherited from class AbstractCachingViewResolver

clearCache, getCacheFilter, getCacheLimit, isCache, isCacheUnresolved, removeFromCache, resolveViewName, setCache, setCacheFilter, setCacheLimit, setCacheUnresolved

Methods inherited from class WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class Object

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

Constructor Details

InternalResourceViewResolver

public InternalResourceViewResolver()

Sets the default view class to requiredViewClass(): by default InternalResourceView, or JstlView if the JSTL API is present.

InternalResourceViewResolver

public InternalResourceViewResolver(String prefix,
 String suffix)

A convenience constructor that allows for specifying prefix and suffix as constructor arguments.

Parameters:

prefix - the prefix that gets prepended to view names when building a URL

suffix - the suffix that gets appended to view names when building a URL

Since:

4.3

Method Details

setAlwaysInclude

public void setAlwaysInclude(boolean alwaysInclude)

Specify whether to always include the view rather than forward to it.

Default is "false". Switch this flag on to enforce the use of a Servlet include, even if a forward would be possible.

See Also:

• InternalResourceView.setAlwaysInclude(boolean)

requiredViewClass

protected Class<?> requiredViewClass()

Description copied from class: UrlBasedViewResolver

Return the required type of view for this resolver. This implementation returns AbstractUrlBasedView.

Overrides:

requiredViewClass in class UrlBasedViewResolver

See Also:

• UrlBasedViewResolver.instantiateView()
• AbstractUrlBasedView

instantiateView

protected AbstractUrlBasedView instantiateView()

Description copied from class: UrlBasedViewResolver

Instantiate the specified view class.

The default implementation uses reflection to instantiate the class.

Overrides:

instantiateView in class UrlBasedViewResolver

Returns:

a new instance of the view class

See Also:

• UrlBasedViewResolver.setViewClass(Class)

buildView

protected AbstractUrlBasedView buildView(String viewName)
                                  throws Exception

Description copied from class: UrlBasedViewResolver

Creates a new View instance of the specified view class and configures it. Does not perform any lookup for pre-defined View instances.

Spring lifecycle methods as defined by the bean container do not have to be called here; those will be applied by the loadView method after this method returns.

Subclasses will typically call super.buildView(viewName) first, before setting further properties themselves. loadView will then apply Spring lifecycle methods at the end of this process.

Overrides:

buildView in class UrlBasedViewResolver

Parameters:

viewName - the name of the view to build

Returns:

the View instance

Throws:

Exception - if the view couldn't be resolved

See Also:

• UrlBasedViewResolver.loadView(String, java.util.Locale)