org.springframework.web.servlet.resource

Class ResourceTransformerSupport

java.lang.Object

org.springframework.web.servlet.resource.ResourceTransformerSupport

All Implemented Interfaces:

ResourceTransformer

Direct Known Subclasses:

AppCacheManifestTransformer, CssLinkResourceTransformer

public abstract class ResourceTransformerSupport
extends java.lang.Object
implements ResourceTransformer

A base class for a ResourceTransformer with an optional helper method for resolving public links within a transformed resource.

Since:

4.1

Author:

Brian Clozel, Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private ResourceUrlProvider	resourceUrlProvider

Constructor Summary

Constructors

Constructor and Description
ResourceTransformerSupport()

Method Summary

Modifier and Type	Method and Description
private ResourceUrlProvider	findResourceUrlProvider(HttpServletRequest request)
ResourceUrlProvider	getResourceUrlProvider()
protected java.lang.String	resolveUrlPath(java.lang.String resourcePath, HttpServletRequest request, Resource resource, ResourceTransformerChain transformerChain) A transformer can use this method when a resource being transformed contains links to other resources.
void	setResourceUrlProvider(ResourceUrlProvider resourceUrlProvider) Configure a ResourceUrlProvider to use when resolving the public URL of links in a transformed resource (e.g.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.servlet.resource.ResourceTransformer

transform

Field Detail

resourceUrlProvider

private ResourceUrlProvider resourceUrlProvider

Constructor Detail

ResourceTransformerSupport

public ResourceTransformerSupport()

Method Detail

setResourceUrlProvider

public void setResourceUrlProvider(ResourceUrlProvider resourceUrlProvider)

Configure a ResourceUrlProvider to use when resolving the public URL of links in a transformed resource (e.g. import links in a CSS file). This is required only for links expressed as full paths, i.e. including context and servlet path, and not for relative links.

By default this property is not set. In that case if a ResourceUrlProvider is needed an attempt is made to find the ResourceUrlProvider exposed through the ResourceUrlProviderExposingInterceptor (configured by default in the MVC Java config and XML namespace). Therefore explicitly configuring this property should not be needed in most cases.

Parameters:

resourceUrlProvider - the URL provider to use

getResourceUrlProvider

public ResourceUrlProvider getResourceUrlProvider()

Returns:

the configured ResourceUrlProvider.

resolveUrlPath

protected java.lang.String resolveUrlPath(java.lang.String resourcePath,
                                          HttpServletRequest request,
                                          Resource resource,
                                          ResourceTransformerChain transformerChain)

A transformer can use this method when a resource being transformed contains links to other resources. Such links need to be replaced with the public facing link as determined by the resource resolver chain (e.g. the public URL may have a version inserted).

Parameters:

resourcePath - the path to a resource that needs to be re-written

request - the current request

resource - the resource being transformed

transformerChain - the transformer chain

Returns:

the resolved URL or null

findResourceUrlProvider

private ResourceUrlProvider findResourceUrlProvider(HttpServletRequest request)