org.springframework.web.servlet.resource

Class ContentBasedVersionStrategy

java.lang.Object

org.springframework.web.servlet.resource.AbstractVersionStrategy

org.springframework.web.servlet.resource.ContentBasedVersionStrategy

All Implemented Interfaces:

VersionStrategy

public class ContentBasedVersionStrategy
extends AbstractVersionStrategy

A VersionStrategy that handles version strings as a Hex MD5 hash in resource file names.

For example the path "styles/foo-e36d2e05253c6c7085a91522ce43a0b4.css" will match to "styles/foo.css" assuming the hash computed from the content of "foo.css" matches the hash in the path.

Since:

4.1

Author:

Jeremy Grelle, Rossen Stoyanchev, Sam Brannen, Brian Clozel

See Also:

VersionResourceResolver

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
ContentBasedVersionStrategy()

Method Summary

Modifier and Type	Method and Description
String	addVersionToUrl(String baseUrl, List<? extends org.springframework.core.io.Resource> locations, ResourceResolverChain chain) Adds a version string to the given baseUrl.
String	deleteVersionFromPath(String requestPath, String candidateVersion) Deletes the given candidate version string from the given request path.
String	extractVersionFromPath(String requestPath) Extracts a version string from the request path.
boolean	resourceVersionMatches(org.springframework.core.io.Resource baseResource, String candidateVersion) Checks whether the given Resource matches the candidate version string.

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

addVersionAsPrefix, addVersionToFilename, deleteVersionAsPrefix, deleteVersionFromFilename, extractVersionAsPrefix, extractVersionFromFilename

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentBasedVersionStrategy

public ContentBasedVersionStrategy()

Method Detail

extractVersionFromPath

public String extractVersionFromPath(String requestPath)

Description copied from interface: VersionStrategy

Extracts a version string from the request path.

Parameters:

requestPath - the request path of the resource being resolved

Returns:

the version string or an empty string if none was found

deleteVersionFromPath

public String deleteVersionFromPath(String requestPath,
                                    String candidateVersion)

Description copied from interface: VersionStrategy

Deletes the given candidate version string from the given request path.

Parameters:

requestPath - the request path of the resource being resolved

candidateVersion - the candidate version string

Returns:

the modified request path, without the version string

resourceVersionMatches

public boolean resourceVersionMatches(org.springframework.core.io.Resource baseResource,
                                      String candidateVersion)

Description copied from interface: VersionStrategy

Checks whether the given Resource matches the candidate version string. Useful when the version string is managed on a per-resource basis.

Parameters:

baseResource - the resource to check against the given version

candidateVersion - the candidate version for the given resource

Returns:

true if the resource matches the version string, false otherwise

addVersionToUrl

public String addVersionToUrl(String baseUrl,
                              List<? extends org.springframework.core.io.Resource> locations,
                              ResourceResolverChain chain)

Description copied from interface: VersionStrategy

Adds a version string to the given baseUrl.

Parameters:

baseUrl - the baseUrl of the requested resource

locations - the resource locations to resolve resources from

chain - the chain of resource resolvers

Returns:

the baseUrl updated with a version string