Spring Framework 6.1.4 · org.springframework.web.servlet.config.annotation.ResourceHandlerRegistration

Modifier and Type	Field and Description
private CacheControl	cacheControl
private Integer	cachePeriod
private Function<Resource, String>	etagGenerator
private final List<Resource>	locationsResources
private final List<String>	locationValues
private boolean	optimizeLocations
private final String[]	pathPatterns
private ResourceChainRegistration	resourceChainRegistration
private boolean	useLastModified

Access	Constructor and Description
public	ResourceHandlerRegistration(String... one or more resource URL path patterns pathPatterns) Create a `ResourceHandlerRegistration` instance.

Method Summary

Modifier and Type	Method and Description
public ResourceHandlerRegistration	Returns: the same `ResourceHandlerRegistration` instance, for chained method invocation addResourceLocations(String... locations) Add one or more resource locations from which to serve static content.
public ResourceHandlerRegistration	Returns: the same `ResourceHandlerRegistration` instance, for chained method invocation addResourceLocations(Resource... the resource locations to use locations) Configure locations to serve static resources from based on pre-resolved `Resource` references.
protected String[]	getPathPatterns() Return the URL path patterns for the resource handler.
protected ResourceHttpRequestHandler	getRequestHandler() Return a `ResourceHttpRequestHandler` instance.
public ResourceChainRegistration	Returns: the same `ResourceHandlerRegistration` instance, for chained method invocation resourceChain(boolean whether to cache the result of resource resolution; setting this to "true" is recommended for production (and "false" for development, especially when applying a version strategy) cacheResources) Configure a chain of resource resolvers and transformers to use.
public ResourceChainRegistration	Returns: the same `ResourceHandlerRegistration` instance, for chained method invocation resourceChain(boolean whether to cache the result of resource resolution; setting this to "true" is recommended for production (and "false" for development, especially when applying a version strategy cacheResources, Cache the cache to use for storing resolved and transformed resources; by default a `org.springframework.cache.concurrent.ConcurrentMapCache` is used. Since Resources aren't serializable and can be dependent on the application host, one should not use a distributed cache but rather an in-memory cache. cache) Configure a chain of resource resolvers and transformers to use.
public ResourceHandlerRegistration	Returns: the same `ResourceHandlerRegistration` instance, for chained method invocation setCacheControl(CacheControl the CacheControl configuration to use cacheControl) Specify the `org.springframework.http.CacheControl` which should be used by the resource handler.
public ResourceHandlerRegistration	Returns: the same `ResourceHandlerRegistration` instance, for chained method invocation setCachePeriod(Integer the time to cache resources in seconds cachePeriod) Specify the cache period for the resources served by the resource handler, in seconds.
public ResourceHandlerRegistration	setEtagGenerator(Function<Resource, String> the HTTP ETag generator function to use. etagGenerator) Configure a generator function that will be used to create the ETag information, given a `Resource` that is about to be written to the response.
public ResourceHandlerRegistration	Returns: the same `ResourceHandlerRegistration` instance, for chained method invocation setOptimizeLocations(boolean whether to optimize the locations through an existence check on startup optimizeLocations) Set whether to optimize the specified locations through an existence check on startup, filtering non-existing directories upfront so that they do not have to be checked on every resource access.
public ResourceHandlerRegistration	Returns: the same `ResourceHandlerRegistration` instance, for chained method invocation setUseLastModified(boolean whether the "last modified" resource information should be used useLastModified) Set whether the `Resource#lastModified()` information should be used to drive HTTP responses.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

cacheControl	back to summary
private CacheControl cacheControl Annotations @Nullable

cachePeriod	back to summary
private Integer cachePeriod Annotations @Nullable

etagGenerator	back to summary
private Function<Resource, String> etagGenerator Annotations @Nullable

locationsResources	back to summary
private final List<Resource> locationsResources

locationValues	back to summary
private final List<String> locationValues

optimizeLocations	back to summary
private boolean optimizeLocations

pathPatterns	back to summary
private final String[] pathPatterns

resourceChainRegistration	back to summary
private ResourceChainRegistration resourceChainRegistration Annotations @Nullable

useLastModified	back to summary
private boolean useLastModified

ResourceHandlerRegistration	back to summary
public ResourceHandlerRegistration(String... pathPatterns) Create a `ResourceHandlerRegistration` instance. Parameters pathPatterns:String[] one or more resource URL path patterns

Method Detail

addResourceLocations back to summary

addResourceLocations	back to summary
public ResourceHandlerRegistration addResourceLocations(String... locations) 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. For `URL-based resources` (e.g. files, HTTP URLs, etc) this method supports a special prefix to indicate the charset associated with the URL so that relative paths appended to it can be encoded correctly, e.g. `[charset=Windows-31J]https://example.org/path`. Returns:ResourceHandlerRegistration the same `ResourceHandlerRegistration` instance, for chained method invocation

public ResourceHandlerRegistration addResourceLocations(String... locations)

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.

For URL-based resources (e.g. files, HTTP URLs, etc) this method supports a special prefix to indicate the charset associated with the URL so that relative paths appended to it can be encoded correctly, e.g. [charset=Windows-31J]https://example.org/path.

Returns:ResourceHandlerRegistration: the same ResourceHandlerRegistration instance, for chained method invocation

addResourceLocations back to summary

addResourceLocations	back to summary
public ResourceHandlerRegistration addResourceLocations(Resource... locations) Configure locations to serve static resources from based on pre-resolved `Resource` references. Parameters locations:Resource[] the resource locations to use Returns:ResourceHandlerRegistration the same `ResourceHandlerRegistration` instance, for chained method invocation Since 5.3.3

public ResourceHandlerRegistration addResourceLocations(Resource... locations)

Configure locations to serve static resources from based on pre-resolved Resource references.

Parameters

locations:Resource[]: the resource locations to use

Returns:ResourceHandlerRegistration

the same ResourceHandlerRegistration instance, for chained method invocation

Since

5.3.3

getPathPatterns	back to summary
protected String[] getPathPatterns() Return the URL path patterns for the resource handler.

getRequestHandler	back to summary
protected ResourceHttpRequestHandler getRequestHandler() Return a `ResourceHttpRequestHandler` instance.

resourceChain back to summary

resourceChain	back to summary
public ResourceChainRegistration resourceChain(boolean cacheResources) Configure a chain of resource resolvers and transformers to use. This can be useful, for example, to apply a version strategy to resource URLs. If this method is not invoked, by default only a simple `PathResourceResolver` is used in order to match URL paths to resources under the configured locations. Parameters cacheResources:boolean whether to cache the result of resource resolution; setting this to "true" is recommended for production (and "false" for development, especially when applying a version strategy) Returns:ResourceChainRegistration the same `ResourceHandlerRegistration` instance, for chained method invocation Since 4.1

public ResourceChainRegistration resourceChain(boolean cacheResources)

Configure a chain of resource resolvers and transformers to use. This can be useful, for example, to apply a version strategy to resource URLs.

If this method is not invoked, by default only a simple PathResourceResolver is used in order to match URL paths to resources under the configured locations.

Parameters

cacheResources:boolean: whether to cache the result of resource resolution; setting this to "true" is recommended for production (and "false" for development, especially when applying a version strategy)

Returns:ResourceChainRegistration

the same ResourceHandlerRegistration instance, for chained method invocation

Since

4.1

resourceChain back to summary

resourceChain	back to summary
public ResourceChainRegistration resourceChain(boolean cacheResources, Cache cache) Configure a chain of resource resolvers and transformers to use. This can be useful, for example, to apply a version strategy to resource URLs. If this method is not invoked, by default only a simple `PathResourceResolver` is used in order to match URL paths to resources under the configured locations. Parameters cacheResources:boolean whether to cache the result of resource resolution; setting this to "true" is recommended for production (and "false" for development, especially when applying a version strategy cache:Cache the cache to use for storing resolved and transformed resources; by default a `org.springframework.cache.concurrent.ConcurrentMapCache` is used. Since Resources aren't serializable and can be dependent on the application host, one should not use a distributed cache but rather an in-memory cache. Returns:ResourceChainRegistration the same `ResourceHandlerRegistration` instance, for chained method invocation Since 4.1

public ResourceChainRegistration resourceChain(boolean cacheResources, Cache cache)

Configure a chain of resource resolvers and transformers to use. This can be useful, for example, to apply a version strategy to resource URLs.

If this method is not invoked, by default only a simple PathResourceResolver is used in order to match URL paths to resources under the configured locations.

Parameters

cacheResources:boolean: whether to cache the result of resource resolution; setting this to "true" is recommended for production (and "false" for development, especially when applying a version strategy
cache:Cache: the cache to use for storing resolved and transformed resources; by default a org.springframework.cache.concurrent.ConcurrentMapCache is used. Since Resources aren't serializable and can be dependent on the application host, one should not use a distributed cache but rather an in-memory cache.

Returns:ResourceChainRegistration

the same ResourceHandlerRegistration instance, for chained method invocation

Since

4.1

setCacheControl back to summary

setCacheControl	back to summary
public ResourceHandlerRegistration setCacheControl(CacheControl cacheControl) Specify the `org.springframework.http.CacheControl` which should be used by the resource handler. Setting a custom value here will override the configuration set with `setCachePeriod`. Parameters cacheControl:CacheControl the CacheControl configuration to use Returns:ResourceHandlerRegistration the same `ResourceHandlerRegistration` instance, for chained method invocation Since 4.2

public ResourceHandlerRegistration setCacheControl(CacheControl cacheControl)

Specify the org.springframework.http.CacheControl which should be used by the resource handler.

Setting a custom value here will override the configuration set with setCachePeriod.

Parameters

cacheControl:CacheControl: the CacheControl configuration to use

Returns:ResourceHandlerRegistration

the same ResourceHandlerRegistration instance, for chained method invocation

Since

4.2

setCachePeriod back to summary

setCachePeriod	back to summary
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:Integer the time to cache resources in seconds Returns:ResourceHandlerRegistration the same `ResourceHandlerRegistration` instance, for chained method invocation

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:Integer: the time to cache resources in seconds

Returns:ResourceHandlerRegistration

the same ResourceHandlerRegistration instance, for chained method invocation

setEtagGenerator back to summary

setEtagGenerator	back to summary
public ResourceHandlerRegistration setEtagGenerator(Function<Resource, String> etagGenerator) Configure a generator function that will be used to create the ETag information, given a `Resource` that is about to be written to the response. This function should return a String that will be used as an argument in `ServerWebExchange#checkNotModified(String)`, or `null` if no value can be generated for the given resource. Parameters etagGenerator:Function<Resource, String> the HTTP ETag generator function to use. Since 6.1 See Also `ResourceHttpRequestHandler#setEtagGenerator(Function)`

public ResourceHandlerRegistration setEtagGenerator(Function<Resource, String> etagGenerator)

Configure a generator function that will be used to create the ETag information, given a Resource that is about to be written to the response.

This function should return a String that will be used as an argument in ServerWebExchange#checkNotModified(String), or null if no value can be generated for the given resource.

Parameters

etagGenerator:Function<Resource, String>: the HTTP ETag generator function to use.

Since

6.1

setOptimizeLocations back to summary

setOptimizeLocations	back to summary
public ResourceHandlerRegistration setOptimizeLocations(boolean optimizeLocations) Set whether to optimize the specified locations through an existence check on startup, filtering non-existing directories upfront so that they do not have to be checked on every resource access. The default is `false`, for defensiveness against zip files without directory entries which are unable to expose the existence of a directory upfront. Switch this flag to `true` for optimized access in case of a consistent jar layout with directory entries. Parameters optimizeLocations:boolean whether to optimize the locations through an existence check on startup Returns:ResourceHandlerRegistration the same `ResourceHandlerRegistration` instance, for chained method invocation Since 5.3.13 See Also `ResourceHttpRequestHandler#setOptimizeLocations`

public ResourceHandlerRegistration setOptimizeLocations(boolean optimizeLocations)

Set whether to optimize the specified locations through an existence check on startup, filtering non-existing directories upfront so that they do not have to be checked on every resource access.

The default is false, for defensiveness against zip files without directory entries which are unable to expose the existence of a directory upfront. Switch this flag to true for optimized access in case of a consistent jar layout with directory entries.

Parameters

optimizeLocations:boolean: whether to optimize the locations through an existence check on startup

Returns:ResourceHandlerRegistration

the same ResourceHandlerRegistration instance, for chained method invocation

Since

5.3.13

setUseLastModified back to summary

setUseLastModified	back to summary
public ResourceHandlerRegistration setUseLastModified(boolean useLastModified) Set whether the `Resource#lastModified()` information should be used to drive HTTP responses. This configuration is set to `true` by default. Parameters useLastModified:boolean whether the "last modified" resource information should be used Returns:ResourceHandlerRegistration the same `ResourceHandlerRegistration` instance, for chained method invocation Since 5.3 See Also `ResourceHttpRequestHandler#setUseLastModified`

public ResourceHandlerRegistration setUseLastModified(boolean useLastModified)

Set whether the Resource#lastModified() information should be used to drive HTTP responses.

This configuration is set to true by default.

Parameters

useLastModified:boolean: whether the "last modified" resource information should be used

Returns:ResourceHandlerRegistration

the same ResourceHandlerRegistration instance, for chained method invocation

Since

5.3

public Class ResourceHandlerRegistration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail