org.springframework.web.reactive.resource

Class CachingResourceResolver

java.lang.Object

org.springframework.web.reactive.resource.AbstractResourceResolver

org.springframework.web.reactive.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 caches the result.

Since:

5.0

Author:

Rossen Stoyanchev, Brian Clozel

Field Summary

Fields

Modifier and Type	Field and Description
private Cache	cache
private java.util.List<java.lang.String>	contentCodings
static java.lang.String	RESOLVED_RESOURCE_CACHE_KEY_PREFIX The prefix used for resolved resource cache keys.
static java.lang.String	RESOLVED_URL_PATH_CACHE_KEY_PREFIX The prefix used for resolved URL path cache keys.

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

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	computeKey(ServerWebExchange exchange, java.lang.String requestPath)
Cache	getCache() Return the configured Cache.
private java.lang.String	getContentCodingKey(ServerWebExchange exchange)
java.util.List<java.lang.String>	getContentCodings() Return a read-only list with the supported content codings.
protected <any>	resolveResourceInternal(ServerWebExchange exchange, java.lang.String requestPath, java.util.List<? extends Resource> locations, ResourceResolverChain chain)
protected <any>	resolveUrlPathInternal(java.lang.String resourceUrlPath, java.util.List<? extends Resource> locations, ResourceResolverChain chain)
void	setContentCodings(java.util.List<java.lang.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.reactive.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 java.lang.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 java.lang.String RESOLVED_URL_PATH_CACHE_KEY_PREFIX

The prefix used for resolved URL path cache keys.

See Also:

Constant Field Values

cache

private final Cache cache

contentCodings

private final java.util.List<java.lang.String> contentCodings

Constructor Detail

CachingResourceResolver

public CachingResourceResolver(Cache cache)

CachingResourceResolver

public CachingResourceResolver(CacheManager cacheManager,
                               java.lang.String cacheName)

Method Detail

getCache

public Cache getCache()

Return the configured Cache.

setContentCodings

public void setContentCodings(java.util.List<java.lang.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 java.util.List<java.lang.String> getContentCodings()

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

Since:

5.1

resolveResourceInternal

protected <any> resolveResourceInternal(@Nullable
                                        ServerWebExchange exchange,
                                        java.lang.String requestPath,
                                        java.util.List<? extends Resource> locations,
                                        ResourceResolverChain chain)

Specified by:

resolveResourceInternal in class AbstractResourceResolver

computeKey

protected java.lang.String computeKey(@Nullable
                                      ServerWebExchange exchange,
                                      java.lang.String requestPath)

getContentCodingKey

@Nullable
private java.lang.String getContentCodingKey(ServerWebExchange exchange)

resolveUrlPathInternal

protected <any> resolveUrlPathInternal(java.lang.String resourceUrlPath,
                                       java.util.List<? extends Resource> locations,
                                       ResourceResolverChain chain)

Specified by:

resolveUrlPathInternal in class AbstractResourceResolver