org.springframework.web.servlet.resource

Class CachingResourceResolver

java.lang.Object

org.springframework.web.servlet.resource.AbstractResourceResolver

org.springframework.web.servlet.resource.CachingResourceResolver

All Implemented Interfaces:

ResourceResolver

public class CachingResourceResolver
extends AbstractResourceResolver

A ResourceResolver that resolves resources from a Cache or otherwise delegates to the resolver chain and saves the result in the cache.

Since:

4.1

Author:

Rossen Stoyanchev, Brian Clozel

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOLVED_RESOURCE_CACHE_KEY_PREFIX The prefix used for resolved resource cache keys.
static String	RESOLVED_URL_PATH_CACHE_KEY_PREFIX The prefix used for resolved URL path cache keys.

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

logger

Constructor Summary

Constructors

Constructor and Description
CachingResourceResolver(Cache cache)
CachingResourceResolver(CacheManager cacheManager, String cacheName)

Method Summary

Modifier and Type	Method and Description
protected String	computeKey(HttpServletRequest request, String requestPath)
Cache	getCache() Return the configured Cache.
List<String>	getContentCodings() Return a read-only list with the supported content codings.
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	setContentCodings(List<String> codings) Configure the supported content codings from the "Accept-Encoding" header for which to cache resource variations.

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

Field Detail

RESOLVED_RESOURCE_CACHE_KEY_PREFIX

public static final String RESOLVED_RESOURCE_CACHE_KEY_PREFIX

The prefix used for resolved resource cache keys.

See Also:

Constant Field Values

RESOLVED_URL_PATH_CACHE_KEY_PREFIX

public static final String RESOLVED_URL_PATH_CACHE_KEY_PREFIX

The prefix used for resolved URL path cache keys.

See Also:

Constant Field Values

Constructor Detail

CachingResourceResolver

public CachingResourceResolver(Cache cache)

CachingResourceResolver

public CachingResourceResolver(CacheManager cacheManager,
                               String cacheName)

Method Detail

getCache

public Cache getCache()

Return the configured Cache.

setContentCodings

public void setContentCodings(List<String> codings)

Configure the supported content codings from the "Accept-Encoding" header for which to cache resource variations.

The codings configured here are generally expected to match those configured on EncodedResourceResolver.setContentCodings(List).

By default this property is set to ["br", "gzip"] based on the value of EncodedResourceResolver.DEFAULT_CODINGS.

Parameters:

codings - one or more supported content codings

Since:

5.1

getContentCodings

public List<String> getContentCodings()

Return a read-only list with the supported content codings.

Since:

5.1

resolveResourceInternal

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

Specified by:

resolveResourceInternal in class AbstractResourceResolver

computeKey

protected String computeKey(@Nullable
                            HttpServletRequest request,
                            String requestPath)

resolveUrlPathInternal

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

Specified by:

resolveUrlPathInternal in class AbstractResourceResolver