org.springframework.web.servlet.resource

Class VersionResourceResolver

java.lang.Object

org.springframework.web.servlet.resource.AbstractResourceResolver

org.springframework.web.servlet.resource.VersionResourceResolver

All Implemented Interfaces:

ResourceResolver

public class VersionResourceResolver
extends AbstractResourceResolver

A ResourceResolver that resolves request paths containing a version string, i.e. version information about the resource being requested. This resolver can be useful to set up HTTP caching strategies by changing resources' URLs as they are updated.

Because resource versioning depends on the resource types, this ResourceResolver needs to be configured with at least one VersionStrategy. The process of matching and generating version strings is delegated to the VersionStrategy.

When resolving resources, this resolver will first delegate to the chain to locate an existing resource and then attempt to extract a version string from the request path and then find a resource that matches that version.

When resolving URLs, this resolver will, if necessary, add a version string in the request path.

Since:

4.1

Author:

Brian Clozel

See Also:

VersionStrategy

Field Summary

Fields inherited from class org.springframework.web.servlet.resource.AbstractResourceResolver

logger

Constructor Summary

Constructors

Constructor and Description
VersionResourceResolver()

Method Summary

Modifier and Type	Method and Description
protected VersionStrategy	getStrategyForPath(String requestPath) Finds a VersionStrategy for the request path of the requested resource.
protected Resource	resolveResourceInternal(HttpServletRequest request, String requestPath, List<? extends Resource> locations, ResourceResolverChain chain)
protected String	resolveUrlPathInternal(String resourceUrlPath, List<? extends Resource> locations, ResourceResolverChain chain)
void	setStrategyMap(Map<String,VersionStrategy> versionStrategyMap) Set a Map with URL paths as keys and VersionStrategy as values.

Methods inherited from class org.springframework.web.servlet.resource.AbstractResourceResolver

resolveResource, resolveUrlPath

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionResourceResolver

public VersionResourceResolver()

Method Detail

setStrategyMap

public void setStrategyMap(Map<String,VersionStrategy> versionStrategyMap)

Set a Map with URL paths as keys and VersionStrategy as values.

Supports direct URL matches and Ant-style pattern matches. For syntax details, see the AntPathMatcher javadoc.

Parameters:

versionStrategyMap - map with URLs as keys and version strategies as values

resolveResourceInternal

protected Resource resolveResourceInternal(HttpServletRequest request,
                                           String requestPath,
                                           List<? extends Resource> locations,
                                           ResourceResolverChain chain)

Specified by:

resolveResourceInternal in class AbstractResourceResolver

resolveUrlPathInternal

protected String resolveUrlPathInternal(String resourceUrlPath,
                                        List<? extends Resource> locations,
                                        ResourceResolverChain chain)

Specified by:

resolveUrlPathInternal in class AbstractResourceResolver

getStrategyForPath

protected VersionStrategy getStrategyForPath(String requestPath)

Finds a VersionStrategy for the request path of the requested resource.

Returns:

an instance of a VersionStrategy or null if none matches that request path