Spring Framework 6.1.4 · org.springframework.web.servlet.view.UrlBasedViewResolver

Modifier and Type	Field and Description
private String	contentType
private Boolean	exposeContextBeansAsAttributes
private String[]	exposedContextBeanNames
private Boolean	exposePathVariables
public static final String	FORWARD_URL_PREFIX Prefix for special view names that specify a forward URL (usually to a controller after a form has been submitted and processed).
private int	order
private String	prefix
public static final String	REDIRECT_URL_PREFIX Prefix for special view names that specify a redirect URL (usually to a controller after a form has been submitted and processed).
private boolean	redirectContextRelative
private String[]	redirectHosts
private boolean	redirectHttp10Compatible
private String	requestContextAttribute
private final Map<String, Object>	staticAttributes Map of static attributes, keyed by attribute name (String).
private String	suffix
private Class<?>	viewClass
private String[]	viewNames

Access	Constructor and Description
public	UrlBasedViewResolver()

Method Summary

Modifier and Type	Method and Description
protected View	Returns: the `View` instance to use (either the original one or a decorated variant) applyLifecycleMethods(String the name of the view viewName, AbstractUrlBasedView the freshly created View instance, pre-configured with `AbstractUrlBasedView`'s properties view) Apply the containing `ApplicationContext`'s lifecycle methods to the given `View` instance, if such a context is available.
protected AbstractUrlBasedView	Returns: the View instance buildView(String the name of the view to build viewName) Creates a new View instance of the specified view class and configures it.
protected boolean	Returns: whether this resolver applies to the specified view canHandle(String the name of the view to retrieve viewName, Locale the Locale to retrieve the view for locale) Indicates whether this `org.springframework.web.servlet.ViewResolver` can handle the supplied view name.
protected View	createView(String the name of the view to retrieve viewName, Locale the Locale to retrieve the view for locale) Overrides org.springframework.web.servlet.view.AbstractCachingViewResolver.createView. Overridden to implement check for "redirect:" prefix.
public Map<String, Object>	getAttributesMap() Allow `Map` access to the static attributes for views returned by this resolver, with the option to add or override specific entries.
protected Object	getCacheKey(String viewName, Locale locale) Overrides org.springframework.web.servlet.view.AbstractCachingViewResolver.getCacheKey. This implementation returns just the view name, as this ViewResolver doesn't support localized resolution.
protected String	getContentType() Return the content type for all views, if any.
protected Boolean	getExposeContextBeansAsAttributes()
protected String[]	getExposedContextBeanNames()
protected Boolean	getExposePathVariables() Return whether views resolved by this resolver should add path variables to the model or not.
public int	getOrder() Implements org.springframework.core.Ordered.getOrder. Get the order value of this object.
protected String	getPrefix() Return the prefix that gets prepended to view names when building a URL.
public String[]	getRedirectHosts() Return the configured application hosts for redirect purposes.
protected String	getRequestContextAttribute() Return the name of the RequestContext attribute for all views, if any.
protected String	getSuffix() Return the suffix that gets appended to view names when building a URL.
protected Class<?>	getViewClass() Return the view class to be used to create views.
protected String[]	getViewNames() Return the view names (or name patterns) that can be handled by this `org.springframework.web.servlet.ViewResolver`.
protected void	initApplicationContext() Overrides org.springframework.context.support.ApplicationObjectSupport.initApplicationContext. Subclasses can override this for custom initialization behavior.
protected AbstractUrlBasedView	Returns: a new instance of the view class instantiateView() Instantiate the specified view class.
protected boolean	isRedirectContextRelative() Return whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current ServletContext, i.e. as relative to the web application root.
protected boolean	isRedirectHttp10Compatible() Return whether redirects should stay compatible with HTTP 1.0 clients.
protected View	Returns: the View instance loadView(String the name of the view to retrieve viewName, Locale the Locale to retrieve the view for locale) Implements abstract org.springframework.web.servlet.view.AbstractCachingViewResolver.loadView. Delegates to `buildView` for creating a new instance of the specified view class.
protected Class<?>	requiredViewClass() Return the required type of view for this resolver.
public void	setAttributes(Properties props) Set static attributes from a `java.util.Properties` object, for all views returned by this resolver.
public void	setAttributesMap(Map<String, ?> a Map with name Strings as keys and attribute objects as values attributes) Set static attributes from a Map, for all views returned by this resolver.
public void	setContentType(String contentType) Set the content type for all views.
public 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.
public void	setExposedContextBeanNames(String... exposedContextBeanNames) Specify the names of beans in the context which are supposed to be exposed.
public void	setExposePathVariables(Boolean `true` - all Views resolved by this resolver will expose path variables `false` - no Views resolved by this resolver will expose path variables `null` - individual Views can decide for themselves (this is used by default) exposePathVariables) Specify whether views resolved by this resolver should add path variables to the model or not.
public void	setOrder(int order) Specify the order value for this ViewResolver bean.
public void	setPrefix(String prefix) Set the prefix that gets prepended to view names when building a URL.
public void	setRedirectContextRelative(boolean redirectContextRelative) Set whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current ServletContext, i.e. as relative to the web application root.
public void	setRedirectHosts(String... one or more application hosts redirectHosts) Configure one or more hosts associated with the application.
public void	setRedirectHttp10Compatible(boolean redirectHttp10Compatible) Set whether redirects should stay compatible with HTTP 1.0 clients.
public void	setRequestContextAttribute(String name of the RequestContext attribute requestContextAttribute) Set the name of the RequestContext attribute for all views.
public void	setSuffix(String suffix) Set the suffix that gets appended to view names when building a URL.
public void	setViewClass(Class<?> a class that is assignable to the required view class (by default: AbstractUrlBasedView) viewClass) Set the view class that should be used to create views.
public void	setViewNames(String... viewNames) Set the view names (or name patterns) that can be handled by this `org.springframework.web.servlet.ViewResolver`.

Inherited from org.springframework.web.servlet.view.AbstractCachingViewResolver:: clearCache getCacheFilter getCacheLimit isCache isCacheUnresolved removeFromCache resolveViewName setCache setCacheFilter setCacheLimit setCacheUnresolved

contentType	back to summary
private String contentType Annotations @Nullable

exposeContextBeansAsAttributes	back to summary
private Boolean exposeContextBeansAsAttributes Annotations @Nullable

exposedContextBeanNames	back to summary
private String[] exposedContextBeanNames Annotations @Nullable

exposePathVariables	back to summary
private Boolean exposePathVariables Annotations @Nullable

FORWARD_URL_PREFIX	back to summary
public static final String FORWARD_URL_PREFIX Prefix for special view names that specify a forward URL (usually to a controller after a form has been submitted and processed). Such view names will not be resolved in the configured default way but rather be treated as special shortcut.

order	back to summary
private int order

prefix	back to summary
private String prefix

REDIRECT_URL_PREFIX	back to summary
public static final String REDIRECT_URL_PREFIX Prefix for special view names that specify a redirect URL (usually to a controller after a form has been submitted and processed). Such view names will not be resolved in the configured default way but rather be treated as special shortcut.

redirectContextRelative	back to summary
private boolean redirectContextRelative

redirectHosts	back to summary
private String[] redirectHosts Annotations @Nullable

redirectHttp10Compatible	back to summary
private boolean redirectHttp10Compatible

requestContextAttribute	back to summary
private String requestContextAttribute Annotations @Nullable

staticAttributes	back to summary
private final Map<String, Object> staticAttributes Map of static attributes, keyed by attribute name (String).

suffix	back to summary
private String suffix

viewClass	back to summary
private Class<?> viewClass Annotations @Nullable

viewNames	back to summary
private String[] viewNames Annotations @Nullable

UrlBasedViewResolver	back to summary
public UrlBasedViewResolver()

Method Detail

applyLifecycleMethods back to summary

applyLifecycleMethods	back to summary
protected View applyLifecycleMethods(String viewName, AbstractUrlBasedView view) Apply the containing `ApplicationContext`'s lifecycle methods to the given `View` instance, if such a context is available. Parameters viewName:String the name of the view view:AbstractUrlBasedView the freshly created View instance, pre-configured with `AbstractUrlBasedView`'s properties Returns:View the `View` instance to use (either the original one or a decorated variant) Since 5.0 See Also `getApplicationContext()`, `ApplicationContext#getAutowireCapableBeanFactory()`, `org.springframework.beans.factory.config.AutowireCapableBeanFactory#initializeBean`

protected View applyLifecycleMethods(String viewName, AbstractUrlBasedView view)

Apply the containing ApplicationContext's lifecycle methods to the given View instance, if such a context is available.

Parameters

viewName:String: the name of the view
view:AbstractUrlBasedView: the freshly created View instance, pre-configured with AbstractUrlBasedView's properties

Returns:View

the View instance to use (either the original one or a decorated variant)

Since

5.0

buildView back to summary

buildView	back to summary
protected AbstractUrlBasedView buildView(String viewName) throws Exception 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. Parameters viewName:String the name of the view to build Returns:AbstractUrlBasedView the View instance Exceptions Exception: if the view couldn't be resolved See Also `loadView(String, java.util.Locale)`

protected AbstractUrlBasedView buildView(String viewName) throws Exception

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.

Parameters

viewName:String: the name of the view to build

Returns:AbstractUrlBasedView

the View instance

Exceptions

Exception:: if the view couldn't be resolved

See Also

loadView(String, java.util.Locale)

canHandle back to summary

canHandle	back to summary
protected boolean canHandle(String viewName, Locale locale) Indicates whether this `org.springframework.web.servlet.ViewResolver` can handle the supplied view name. If not, `createView(String, java.util.Locale)` will return `null`. The default implementation checks against the configured `view names`. Parameters viewName:String the name of the view to retrieve locale:Locale the Locale to retrieve the view for Returns:boolean whether this resolver applies to the specified view See Also `org.springframework.util.PatternMatchUtils#simpleMatch(String, String)`

protected boolean canHandle(String viewName, Locale locale)

Indicates whether this org.springframework.web.servlet.ViewResolver can handle the supplied view name. If not, createView(String, java.util.Locale) will return null. The default implementation checks against the configured view names.

Parameters

viewName:String: the name of the view to retrieve
locale:Locale: the Locale to retrieve the view for

Returns:boolean

whether this resolver applies to the specified view

createView back to summary

createView	back to summary
protected View createView(String viewName, Locale locale) throws Exception Overrides org.springframework.web.servlet.view.AbstractCachingViewResolver.createView. Overridden to implement check for "redirect:" prefix. Not possible in `loadView`, since overridden `loadView` versions in subclasses might rely on the superclass always creating instances of the required view class. Parameters viewName:String Doc from org.springframework.web.servlet.view.AbstractCachingViewResolver.createView. the name of the view to retrieve locale:Locale Doc from org.springframework.web.servlet.view.AbstractCachingViewResolver.createView. the Locale to retrieve the view for Returns:View Doc from org.springframework.web.servlet.view.AbstractCachingViewResolver.createView. the View instance, or `null` if not found (optional, to allow for ViewResolver chaining) Annotations @Override Exceptions Exception: Doc from org.springframework.web.servlet.view.AbstractCachingViewResolver.createView. if the view couldn't be resolved See Also `loadView`, `requiredViewClass`

protected View createView(String viewName, Locale locale) throws Exception

Overrides org.springframework.web.servlet.view.AbstractCachingViewResolver.createView.

Overridden to implement check for "redirect:" prefix.

Not possible in loadView, since overridden loadView versions in subclasses might rely on the superclass always creating instances of the required view class.

Parameters

viewName:String

Doc from org.springframework.web.servlet.view.AbstractCachingViewResolver.createView.

the name of the view to retrieve

locale:Locale

Doc from org.springframework.web.servlet.view.AbstractCachingViewResolver.createView.

the Locale to retrieve the view for

Returns:View

Doc from org.springframework.web.servlet.view.AbstractCachingViewResolver.createView.

the View instance, or null if not found (optional, to allow for ViewResolver chaining)

Annotations

@Override

Exceptions

Exception:

Doc from org.springframework.web.servlet.view.AbstractCachingViewResolver.createView.

if the view couldn't be resolved

See Also

loadView, requiredViewClass

getAttributesMap back to summary

getAttributesMap	back to summary
public Map<String, Object> getAttributesMap() Allow `Map` access to the static attributes for views returned by this resolver, with the option to add or override specific entries. Useful for specifying entries directly, for example via `attributesMap[myKey]`. This is particularly useful for adding or overriding entries in child view definitions.

public Map<String, Object> getAttributesMap()

Allow Map access to the static attributes for views returned by this resolver, with the option to add or override specific entries.

Useful for specifying entries directly, for example via attributesMap[myKey]. This is particularly useful for adding or overriding entries in child view definitions.

getCacheKey	back to summary
protected Object getCacheKey(String viewName, Locale locale) Overrides org.springframework.web.servlet.view.AbstractCachingViewResolver.getCacheKey. This implementation returns just the view name, as this ViewResolver doesn't support localized resolution. Annotations @Override

getCacheKey

back to summary

protected Object getCacheKey(String viewName, Locale locale)

Overrides org.springframework.web.servlet.view.AbstractCachingViewResolver.getCacheKey.

This implementation returns just the view name, as this ViewResolver doesn't support localized resolution.

Annotations

@Override

getContentType	back to summary
protected String getContentType() Return the content type for all views, if any. Annotations @Nullable

getContentType

back to summary

protected String getContentType()

Return the content type for all views, if any.

Annotations

@Nullable

getExposeContextBeansAsAttributes	back to summary
protected Boolean getExposeContextBeansAsAttributes() Annotations @Nullable

getExposedContextBeanNames	back to summary
protected String[] getExposedContextBeanNames() Annotations @Nullable

getExposePathVariables	back to summary
protected Boolean getExposePathVariables() Return whether views resolved by this resolver should add path variables to the model or not. Annotations @Nullable

getExposePathVariables

back to summary

protected Boolean getExposePathVariables()

Return whether views resolved by this resolver should add path variables to the model or not.

Annotations

@Nullable

getOrder back to summary

getOrder	back to summary
public int getOrder() Implements org.springframework.core.Ordered.getOrder. Doc from org.springframework.core.Ordered.getOrder. Get the order value of this object. Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet `load-on-startup` values). Same order values will result in arbitrary sort positions for the affected objects. Returns:int the order value Annotations @Override

public int getOrder()

Implements org.springframework.core.Ordered.getOrder.

Doc from org.springframework.core.Ordered.getOrder.

Get the order value of this object.

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

Same order values will result in arbitrary sort positions for the affected objects.

Returns:int

the order value

Annotations

@Override

getPrefix	back to summary
protected String getPrefix() Return the prefix that gets prepended to view names when building a URL.

getRedirectHosts	back to summary
public String[] getRedirectHosts() Return the configured application hosts for redirect purposes. Annotations @Nullable Since 4.3

getRedirectHosts

back to summary

public String[] getRedirectHosts()

Return the configured application hosts for redirect purposes.

Annotations

@Nullable

Since

4.3

getRequestContextAttribute	back to summary
protected String getRequestContextAttribute() Return the name of the RequestContext attribute for all views, if any. Annotations @Nullable

getRequestContextAttribute

back to summary

protected String getRequestContextAttribute()

Return the name of the RequestContext attribute for all views, if any.

Annotations

@Nullable

getSuffix	back to summary
protected String getSuffix() Return the suffix that gets appended to view names when building a URL.

getViewClass back to summary

getViewClass	back to summary
protected Class<?> getViewClass() Return the view class to be used to create views. Annotations @Nullable See Also `setViewClass`

protected Class<?> getViewClass()

Return the view class to be used to create views.

Annotations

@Nullable

See Also

setViewClass

getViewNames back to summary

getViewNames	back to summary
protected String[] getViewNames() Return the view names (or name patterns) that can be handled by this `org.springframework.web.servlet.ViewResolver`. Annotations @Nullable

protected String[] getViewNames()

Return the view names (or name patterns) that can be handled by this org.springframework.web.servlet.ViewResolver.

Annotations

@Nullable

initApplicationContext back to summary

initApplicationContext	back to summary
protected void initApplicationContext() Overrides org.springframework.context.support.ApplicationObjectSupport.initApplicationContext. Doc from org.springframework.context.support.ApplicationObjectSupport.initApplicationContext. Subclasses can override this for custom initialization behavior. The default implementation is empty. Called by `initApplicationContext(ApplicationContext)`. Annotations @Override

protected void initApplicationContext()

Overrides org.springframework.context.support.ApplicationObjectSupport.initApplicationContext.

Doc from org.springframework.context.support.ApplicationObjectSupport.initApplicationContext.

Subclasses can override this for custom initialization behavior.

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

Annotations

@Override

instantiateView back to summary

instantiateView	back to summary
protected AbstractUrlBasedView instantiateView() Instantiate the specified view class. The default implementation uses reflection to instantiate the class. Returns:AbstractUrlBasedView a new instance of the view class Since 5.3 See Also `setViewClass`

protected AbstractUrlBasedView instantiateView()

Instantiate the specified view class.

The default implementation uses reflection to instantiate the class.

Returns:AbstractUrlBasedView: a new instance of the view class
Since: 5.3
See Also: setViewClass

isRedirectContextRelative	back to summary
protected boolean isRedirectContextRelative() Return whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current ServletContext, i.e. as relative to the web application root.

isRedirectHttp10Compatible	back to summary
protected boolean isRedirectHttp10Compatible() Return whether redirects should stay compatible with HTTP 1.0 clients.

loadView back to summary

loadView	back to summary
protected View loadView(String viewName, Locale locale) throws Exception Implements abstract org.springframework.web.servlet.view.AbstractCachingViewResolver.loadView. Delegates to `buildView` for creating a new instance of the specified view class. Applies the following Spring lifecycle methods (as supported by the generic Spring bean factory): ApplicationContextAware's `setApplicationContext` InitializingBean's `afterPropertiesSet` Parameters viewName:String the name of the view to retrieve locale:Locale Doc from org.springframework.web.servlet.view.AbstractCachingViewResolver.loadView. the Locale to retrieve the view for Returns:View the View instance Annotations @Override Exceptions Exception: if the view couldn't be resolved See Also `buildView(String)`, `org.springframework.context.ApplicationContextAware#setApplicationContext`, `org.springframework.beans.factory.InitializingBean#afterPropertiesSet`

protected View loadView(String viewName, Locale locale) throws Exception

Implements abstract org.springframework.web.servlet.view.AbstractCachingViewResolver.loadView.

Delegates to buildView for creating a new instance of the specified view class. Applies the following Spring lifecycle methods (as supported by the generic Spring bean factory):

ApplicationContextAware's setApplicationContext
InitializingBean's afterPropertiesSet

Parameters

viewName:String

the name of the view to retrieve

locale:Locale

Doc from org.springframework.web.servlet.view.AbstractCachingViewResolver.loadView.

the Locale to retrieve the view for

Returns:View

the View instance

Annotations

@Override

Exceptions

Exception:: if the view couldn't be resolved

requiredViewClass back to summary

requiredViewClass	back to summary
protected Class<?> requiredViewClass() Return the required type of view for this resolver. This implementation returns `AbstractUrlBasedView`. See Also `instantiateView()`, `AbstractUrlBasedView`

protected Class<?> requiredViewClass()

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

See Also: instantiateView(), AbstractUrlBasedView

setAttributes back to summary

setAttributes	back to summary
public void setAttributes(Properties props) Set static attributes from a `java.util.Properties` object, for all views returned by this resolver. This is the most convenient way to set static attributes. Note that static attributes can be overridden by dynamic attributes, if a value with the same name is included in the model. Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions. See Also `org.springframework.beans.propertyeditors.PropertiesEditor`, `AbstractView#setAttributes`

public void setAttributes(Properties props)

Set static attributes from a java.util.Properties object, for all views returned by this resolver.

This is the most convenient way to set static attributes. Note that static attributes can be overridden by dynamic attributes, if a value with the same name is included in the model.

Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions.

See Also: org.springframework.beans.propertyeditors.PropertiesEditor, AbstractView#setAttributes

setAttributesMap back to summary

setAttributesMap	back to summary
public void setAttributesMap(Map<String, ?> attributes) Set static attributes from a Map, for all views returned by this resolver. This allows to set any kind of attribute values, for example bean references. Can be populated with a "map" or "props" element in XML bean definitions. Parameters attributes:Map<String, ?> a Map with name Strings as keys and attribute objects as values See Also `AbstractView#setAttributesMap`

public void setAttributesMap(Map<String, ?> attributes)

Set static attributes from a Map, for all views returned by this resolver. This allows to set any kind of attribute values, for example bean references.

Can be populated with a "map" or "props" element in XML bean definitions.

Parameters

attributes:Map<String, ?>: a Map with name Strings as keys and attribute objects as values

See Also

AbstractView#setAttributesMap

setContentType	back to summary
public void setContentType(String contentType) Set the content type for all views. May be ignored by view classes if the view itself is assumed to set the content type, e.g. in case of JSPs.

setContentType

back to summary

public void setContentType(String contentType)

Set the content type for all views.

May be ignored by view classes if the view itself is assumed to set the content type, e.g. in case of JSPs.

setExposeContextBeansAsAttributes back to summary

setExposeContextBeansAsAttributes	back to summary
public 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. This will make all such beans accessible in plain `${...}` expressions in a JSP 2.0 page, as well as in JSTL's `c:out` value expressions. Default is "false". See Also `AbstractView#setExposeContextBeansAsAttributes`

public 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.

This will make all such beans accessible in plain ${...} expressions in a JSP 2.0 page, as well as in JSTL's c:out value expressions.

Default is "false".

See Also: AbstractView#setExposeContextBeansAsAttributes

setExposedContextBeanNames back to summary

setExposedContextBeanNames	back to summary
public void setExposedContextBeanNames(String... exposedContextBeanNames) Specify the names of beans in the context which are supposed to be exposed. If this is non-null, only the specified beans are eligible for exposure as attributes. See Also `AbstractView#setExposedContextBeanNames`

public void setExposedContextBeanNames(String... exposedContextBeanNames)

Specify the names of beans in the context which are supposed to be exposed. If this is non-null, only the specified beans are eligible for exposure as attributes.

See Also: AbstractView#setExposedContextBeanNames

setExposePathVariables back to summary

setExposePathVariables	back to summary
public void setExposePathVariables(Boolean exposePathVariables) Specify whether views resolved by this resolver should add path variables to the model or not. The default setting is to let each View decide (see `AbstractView#setExposePathVariables`). However, you can use this property to override that. Parameters exposePathVariables:Boolean `true` - all Views resolved by this resolver will expose path variables `false` - no Views resolved by this resolver will expose path variables `null` - individual Views can decide for themselves (this is used by default) See Also `AbstractView#setExposePathVariables`

public void setExposePathVariables(Boolean exposePathVariables)

Specify whether views resolved by this resolver should add path variables to the model or not.

The default setting is to let each View decide (see AbstractView#setExposePathVariables). However, you can use this property to override that.

Parameters

exposePathVariables:Boolean

true - all Views resolved by this resolver will expose path variables
false - no Views resolved by this resolver will expose path variables
null - individual Views can decide for themselves (this is used by default)

See Also

AbstractView#setExposePathVariables

setOrder back to summary

setOrder	back to summary
public void setOrder(int order) Specify the order value for this ViewResolver bean. The default value is `Ordered.LOWEST_PRECEDENCE`, meaning non-ordered. See Also `org.springframework.core.Ordered#getOrder()`

public void setOrder(int order)

Specify the order value for this ViewResolver bean.

The default value is Ordered.LOWEST_PRECEDENCE, meaning non-ordered.

See Also: org.springframework.core.Ordered#getOrder()

setPrefix	back to summary
public void setPrefix(String prefix) Set the prefix that gets prepended to view names when building a URL.

setRedirectContextRelative back to summary

public void setRedirectContextRelative(boolean redirectContextRelative)

Set whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current ServletContext, i.e. as relative to the web application root.

Default is "true": A redirect URL that starts with a slash will be interpreted as relative to the web application root, i.e. the context path will be prepended to the URL.

Redirect URLs can be specified via the "redirect:" prefix. E.g.: "redirect:myAction"

See Also: RedirectView#setContextRelative, REDIRECT_URL_PREFIX

setRedirectHosts back to summary

public void setRedirectHosts(String... redirectHosts)

Configure one or more hosts associated with the application. All other hosts will be considered external hosts.

In effect, this property provides a way turn off encoding on redirect via HttpServletResponse#encodeRedirectURL for URLs that have a host and that host is not listed as a known host.

If not set (the default) all URLs are encoded through the response.

Parameters

redirectHosts:String[]: one or more application hosts

Since

4.3

setRedirectHttp10Compatible back to summary

public void setRedirectHttp10Compatible(boolean redirectHttp10Compatible)

Set whether redirects should stay compatible with HTTP 1.0 clients.

In the default implementation, this will enforce HTTP status code 302 in any case, i.e. delegate to HttpServletResponse.sendRedirect. Turning this off will send HTTP status code 303, which is the correct code for HTTP 1.1 clients, but not understood by HTTP 1.0 clients.

Many HTTP 1.1 clients treat 302 just like 303, not making any difference. However, some clients depend on 303 when redirecting after a POST request; turn this flag off in such a scenario.

Redirect URLs can be specified via the "redirect:" prefix. E.g.: "redirect:myAction"

See Also: RedirectView#setHttp10Compatible, REDIRECT_URL_PREFIX

setRequestContextAttribute back to summary

public void setRequestContextAttribute(String requestContextAttribute)

Set the name of the RequestContext attribute for all views.

Parameters

requestContextAttribute:String: name of the RequestContext attribute

setSuffix	back to summary
public void setSuffix(String suffix) Set the suffix that gets appended to view names when building a URL.

setViewClass back to summary

public void setViewClass(Class<?> viewClass)

Set the view class that should be used to create views.

Parameters

viewClass:Class<?>: a class that is assignable to the required view class (by default: AbstractUrlBasedView)

setViewNames back to summary

public void setViewNames(String... viewNames)

Set the view names (or name patterns) that can be handled by this org.springframework.web.servlet.ViewResolver. View names can contain simple wildcards such that 'my*', '*Report' and '*Repo*' will all match the view name 'myReport'.

See Also: canHandle

public Class UrlBasedViewResolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail