org.springframework.web.servlet.config.annotation

Class ResourceHandlerRegistration

java.lang.Object

org.springframework.web.servlet.config.annotation.ResourceHandlerRegistration

public class ResourceHandlerRegistration
extends Object

Encapsulates information required to create a resource handlers.

Since:

3.1

Author:

Rossen Stoyanchev, Keith Donald, Brian Clozel

Constructor Summary

Constructors

Constructor and Description
ResourceHandlerRegistration(ResourceLoader resourceLoader, String... pathPatterns) Create a ResourceHandlerRegistration instance.

Method Summary

Modifier and Type	Method and Description
ResourceHandlerRegistration	addResolver(ResourceResolver resolver) Add a ResourceResolver to the chain, allowing to resolve server-side resources from HTTP requests.
ResourceHandlerRegistration	addResourceLocations(String... resourceLocations) Add one or more resource locations from which to serve static content.
ResourceHandlerRegistration	addTransformer(ResourceTransformer transformer) Add a ResourceTransformer to the chain, allowing to transform the content of server-side resources when serving them to HTTP clients.
ResourceHandlerRegistration	addVersion(String fixedVersion, String... pathPatterns) Apply Resource Versioning on the matching resources using a FixedVersionStrategy.
ResourceHandlerRegistration	addVersionHash(String... pathPatterns) Apply Resource Versioning on the matching resources using a ContentVersionStrategy.
ResourceHandlerRegistration	addVersionStrategy(VersionStrategy strategy, String... pathPatterns) Apply Resource Versioning on the matching resources; this will update resources' URLs to include a version string calculated by a VersionStrategy.
ResourceHandlerRegistration	enableDevMode() Disable automatic registration of caching Resolver/Transformer, thus disabling Resource caching if no caching Resolver/Transformer was manually registered.
protected String[]	getPathPatterns() Returns the URL path patterns for the resource handler.
protected ResourceHttpRequestHandler	getRequestHandler() Returns a ResourceHttpRequestHandler instance.
protected List<ResourceResolver>	getResourceResolvers()
protected List<ResourceTransformer>	getResourceTransformers()
ResourceHandlerRegistration	setCachePeriod(Integer cachePeriod) Specify the cache period for the resources served by the resource handler, in seconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceHandlerRegistration

public ResourceHandlerRegistration(ResourceLoader resourceLoader,
                                   String... pathPatterns)

Create a ResourceHandlerRegistration instance.

Parameters:

resourceLoader - a resource loader for turning a String location into a Resource

pathPatterns - one or more resource URL path patterns

Method Detail

addResourceLocations

public ResourceHandlerRegistration addResourceLocations(String... resourceLocations)

Add one or more resource locations from which to serve static content. Each location must point to a valid directory. Multiple locations may be specified as a comma-separated list, and the locations will be checked for a given resource in the order specified.

For example, {"/", "classpath:/META-INF/public-web-resources/"} allows resources to be served both from the web application root and from any JAR on the classpath that contains a /META-INF/public-web-resources/ directory, with resources in the web application root taking precedence.

Returns:

the same ResourceHandlerRegistration instance for chained method invocation

addResolver

public ResourceHandlerRegistration addResolver(ResourceResolver resolver)

Add a ResourceResolver to the chain, allowing to resolve server-side resources from HTTP requests.

ResourceResolvers are registered, in the following order:

1. a CachingResourceResolver for caching the results of the next Resolvers; this resolver is only registered if you did not provide your own instance of CachingResourceResolver at the beginning of the chain
2. all ResourceResolvers registered using this method, in the order of methods calls
3. a VersionResourceResolver if a versioning configuration has been applied with addVersionStrategy, addVersion, etc.
4. a PathResourceResolver for resolving resources on the file system

Parameters:

resolver - a ResourceResolver to add to the chain of resolvers

Returns:

the same ResourceHandlerRegistration instance for chained method invocation

Since:

4.1

See Also:

ResourceResolver

addTransformer

public ResourceHandlerRegistration addTransformer(ResourceTransformer transformer)

Add a ResourceTransformer to the chain, allowing to transform the content of server-side resources when serving them to HTTP clients.

ResourceTransformers are registered, in the following order:

1. a CachingResourceTransformer for caching the results of the next Transformers; this transformer is only registered if you did not provide your own instance of CachingResourceTransformer at the beginning of the chain
2. a CssLinkResourceTransformer for updating links within CSS files; this transformer is only registered if a versioning configuration has been applied with addVersionStrategy, addVersion, etc
3. all ResourceTransformers registered using this method, in the order of methods calls

Parameters:

transformer - a ResourceTransformer to add to the chain of transformers

Returns:

the same ResourceHandlerRegistration instance for chained method invocation

Since:

4.1

See Also:

ResourceResolver

addVersionStrategy

public ResourceHandlerRegistration addVersionStrategy(VersionStrategy strategy,
                                                      String... pathPatterns)

Apply Resource Versioning on the matching resources; this will update resources' URLs to include a version string calculated by a VersionStrategy. This is often used for cache busting.

Note that a CssLinkResourceTransformer will be automatically registered to support versioned resources in CSS files.

Parameters:

strategy - the versioning strategy to use

pathPatterns - one or more resource URL path patterns

Returns:

the same ResourceHandlerRegistration instance for chained method invocation

Since:

4.1

See Also:

VersionResourceResolver, VersionStrategy

addVersion

public ResourceHandlerRegistration addVersion(String fixedVersion,
                                              String... pathPatterns)

Apply Resource Versioning on the matching resources using a FixedVersionStrategy.

This strategy uses that fixed version string and adds it as a prefix in the resource path, e.g. fixedversion/js/main.js.

There are many ways to get a version string for your application:

• create a string using the current date, a source of random numbers at runtime
• fetch a version string from a property source or an Env variable, using SpEL or @Value

Note that a CssLinkResourceTransformer will be automatically registered to support versioned resources in CSS files.

Parameters:

fixedVersion - a version string

pathPatterns - one or more resource URL path patterns

Returns:

the same ResourceHandlerRegistration instance for chained method invocation

Since:

4.1

See Also:

VersionResourceResolver, FixedVersionStrategy

addVersionHash

public ResourceHandlerRegistration addVersionHash(String... pathPatterns)

Apply Resource Versioning on the matching resources using a ContentVersionStrategy.

This strategy uses the content of the Resource to create a String hash and adds it in the resource filename, e.g. css/main-e36d2e05253c6c7085a91522ce43a0b4.css.

Note that a CssLinkResourceTransformer will be automatically registered to support versioned resources in CSS files.

Parameters:

pathPatterns - one or more resource URL path patterns

Returns:

the same ResourceHandlerRegistration instance for chained method invocation

Since:

4.1

See Also:

VersionResourceResolver, ContentVersionStrategy

enableDevMode

public ResourceHandlerRegistration enableDevMode()

Disable automatic registration of caching Resolver/Transformer, thus disabling Resource caching if no caching Resolver/Transformer was manually registered.

Useful when updating static resources at runtime, i.e. during the development phase.

Returns:

the same ResourceHandlerRegistration instance for chained method invocation

Since:

4.1

See Also:

ResourceResolver, ResourceTransformer

setCachePeriod

public ResourceHandlerRegistration setCachePeriod(Integer cachePeriod)

Specify the cache period for the resources served by the resource handler, in seconds. The default is to not send any cache headers but to rely on last-modified timestamps only. Set to 0 in order to send cache headers that prevent caching, or to a positive number of seconds to send cache headers with the given max-age value.

Parameters:

cachePeriod - the time to cache resources in seconds

Returns:

the same ResourceHandlerRegistration instance for chained method invocation

getPathPatterns

protected String[] getPathPatterns()

Returns the URL path patterns for the resource handler.

getResourceResolvers

protected List<ResourceResolver> getResourceResolvers()

getResourceTransformers

protected List<ResourceTransformer> getResourceTransformers()

getRequestHandler

protected ResourceHttpRequestHandler getRequestHandler()

Returns a ResourceHttpRequestHandler instance.