public class

ResourceBundleViewResolver

extends AbstractCachingViewResolver
implements DisposableBean InitializingBean Ordered
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.ResourceBundleViewResolver

Class Overview

ViewResolver implementation that uses bean definitions in a ResourceBundle, specified by the bundle basename.

The bundle is typically defined in a properties file, located in the class path. The default bundle basename is "views".

This ViewResolver supports localized view definitions, using the default support of java.util.PropertyResourceBundle. For example, the basename "views" will be resolved as class path resources "views_de_AT.properties", "views_de.properties", "views.properties" - for a given Locale "de_AT".

Note: this ViewResolver implements the Ordered interface to allow for flexible participation in ViewResolver chaining. For example, some special views could be defined via this ViewResolver (giving it 0 as "order" value), while all remaining views could be resolved by a UrlBasedViewResolver.

See Also

Summary

Constants
String DEFAULT_BASENAME The default basename if no other basename is supplied.
[Expand]
Inherited Constants
From interface org.springframework.core.Ordered
[Expand]
Inherited Fields
From class org.springframework.context.support.ApplicationObjectSupport
Public Constructors
ResourceBundleViewResolver()
Public Methods
void afterPropertiesSet()
Eagerly initialize Locales if necessary.
void destroy()
Close the bundle View factories on context shutdown.
int getOrder()
Return the order value of this object, with a higher value meaning greater in terms of sorting.
void setBasename(String basename)
Set a single basename, following ResourceBundle conventions.
void setBasenames(String[] basenames)
Set an array of basenames, each following ResourceBundle conventions.
void setBundleClassLoader(ClassLoader classLoader)
Set the ClassLoader to load resource bundles with.
void setDefaultParentView(String defaultParentView)
Set the default parent for views defined in the ResourceBundle.
void setLocalesToInitialize(Locale[] localesToInitialize)
Specify Locales to initialize eagerly, rather than lazily when actually accessed.
void setOrder(int order)
Protected Methods
ResourceBundle getBundle(String basename, Locale locale)
Obtain the resource bundle for the given basename and Locale.
ClassLoader getBundleClassLoader()
Return the ClassLoader to load resource bundles with.
synchronized BeanFactory initFactory(Locale locale)
Initialize the View BeanFactory from the ResourceBundle, for the given locale.
View loadView(String viewName, Locale locale)
Subclasses must implement this method, building a View object for the specified view.
[Expand]
Inherited Methods
From class org.springframework.web.servlet.view.AbstractCachingViewResolver
From class org.springframework.web.context.support.WebApplicationObjectSupport
From class org.springframework.context.support.ApplicationObjectSupport
From class java.lang.Object
From interface org.springframework.beans.factory.DisposableBean
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.context.ApplicationContextAware
From interface org.springframework.core.Ordered
From interface org.springframework.web.context.ServletContextAware
From interface org.springframework.web.servlet.ViewResolver

Constants

public static final String DEFAULT_BASENAME

The default basename if no other basename is supplied.

Constant Value: "views"

Public Constructors

public ResourceBundleViewResolver ()

Public Methods

public void afterPropertiesSet ()

Eagerly initialize Locales if necessary.

Throws
BeansException
See Also

public void destroy ()

Close the bundle View factories on context shutdown.

Throws
BeansException

public int getOrder ()

Return the order value of this object, with a higher value meaning greater in terms of sorting.

Normally starting with 0, with Integer.MAX_VALUE indicating the greatest value. Same order values will result in arbitrary positions for the affected objects.

Higher values can be interpreted as lower priority. As a consequence, the object with the lowest value has highest priority (somewhat analogous to Servlet "load-on-startup" values).

Returns
  • the order value

public void setBasename (String basename)

Set a single basename, following ResourceBundle conventions. The default is "views".

ResourceBundle supports different suffixes. For example, a base name of "views" might map to ResourceBundle files "views", "views_en_au" and "views_de".

Note that ResourceBundle names are effectively classpath locations: As a consequence, the JDK's standard ResourceBundle treats dots as package separators. This means that "test.theme" is effectively equivalent to "test/theme", just like it is for programmatic java.util.ResourceBundle usage.

See Also

public void setBasenames (String[] basenames)

Set an array of basenames, each following ResourceBundle conventions. The default is a single basename "views".

ResourceBundle supports different suffixes. For example, a base name of "views" might map to ResourceBundle files "views", "views_en_au" and "views_de".

The associated resource bundles will be checked sequentially when resolving a message code. Note that message definitions in a previous resource bundle will override ones in a later bundle, due to the sequential lookup.

Note that ResourceBundle names are effectively classpath locations: As a consequence, the JDK's standard ResourceBundle treats dots as package separators. This means that "test.theme" is effectively equivalent to "test/theme", just like it is for programmatic java.util.ResourceBundle usage.

See Also

public void setBundleClassLoader (ClassLoader classLoader)

Set the ClassLoader to load resource bundles with. Default is the thread context ClassLoader.

public void setDefaultParentView (String defaultParentView)

Set the default parent for views defined in the ResourceBundle.

This avoids repeated "yyy1.(parent)=xxx", "yyy2.(parent)=xxx" definitions in the bundle, especially if all defined views share the same parent.

The parent will typically define the view class and common attributes. Concrete views might simply consist of an URL definition then: a la "yyy1.url=/my.jsp", "yyy2.url=/your.jsp".

View definitions that define their own parent or carry their own class can still override this. Strictly speaking, the rule that a default parent setting does not apply to a bean definition that carries a class is there for backwards compatiblity reasons. It still matches the typical use case.

public void setLocalesToInitialize (Locale[] localesToInitialize)

Specify Locales to initialize eagerly, rather than lazily when actually accessed.

Allows for pre-initialization of common Locales, eagerly checking the view configuration for those Locales.

public void setOrder (int order)

Protected Methods

protected ResourceBundle getBundle (String basename, Locale locale)

Obtain the resource bundle for the given basename and Locale.

Parameters
basename the basename to look for
locale the Locale to look for
Returns
  • the corresponding ResourceBundle
Throws
MissingResourceException if no matching bundle could be found
See Also

protected ClassLoader getBundleClassLoader ()

Return the ClassLoader to load resource bundles with.

Default is the specified bundle ClassLoader, usually the thread context ClassLoader.

protected synchronized BeanFactory initFactory (Locale locale)

Initialize the View BeanFactory from the ResourceBundle, for the given locale.

Synchronized because of access by parallel threads.

Parameters
locale the target Locale
Returns
  • the View factory for the given Locale
Throws
BeansException in case of initialization errors

protected View loadView (String viewName, Locale locale)

Subclasses must implement this method, building a View object for the specified view. The returned View objects will be cached by this ViewResolver base class.

Subclasses are not forced to support internationalization: A subclass that does not may simply ignore the locale parameter.

Parameters
viewName the name of the view to retrieve
locale the Locale to retrieve the view for
Returns
  • the View instance, or null if not found (optional, to allow for ViewResolver chaining)
Throws
Exception