Class ResourceHttpRequestHandler

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.resource.ResourceHttpRequestHandler

All Implemented Interfaces:

Aware, InitializingBean, ApplicationContextAware, EmbeddedValueResolverAware, ServletContextAware, CorsConfigurationSource, HttpRequestHandler

public class ResourceHttpRequestHandler
extends WebContentGenerator
implements HttpRequestHandler, EmbeddedValueResolverAware, InitializingBean, CorsConfigurationSource

HttpRequestHandler that serves static resources in an optimized way according to the guidelines of Page Speed, YSlow, etc.

The properties "locations" and "locationValues" accept locations from which static resources can be served by this handler. This can be relative to the root of the web application, or from the classpath, for example, "classpath:/META-INF/public-web-resources/", allowing convenient packaging and serving of resources such as .js, .css, and others in jar files.

This request handler may also be configured with a resourcesResolver and resourceTransformer chains to support arbitrary resolution and transformation of resources being served. By default, a PathResourceResolver simply finds resources based on the configured "locations". An application can configure additional resolvers and transformers such as the VersionResourceResolver which can resolve and prepare URLs for resources with a version in the URL.

This handler also properly evaluates the Last-Modified header (if present) so that a 304 status code will be returned as appropriate, avoiding unnecessary overhead for resources that are already cached by the client.

Since:

3.0.4

Author:

Keith Donald, Jeremy Grelle, Juergen Hoeller, Arjen Poutsma, Brian Clozel, Rossen Stoyanchev

Field Summary

Fields inherited from class WebContentGenerator

HEADER_CACHE_CONTROL, METHOD_GET, METHOD_HEAD, METHOD_POST

Constructor Summary

Constructors

Constructor	Description
ResourceHttpRequestHandler()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.
@Nullable CorsConfiguration	getCorsConfiguration(jakarta.servlet.http.HttpServletRequest request)	Return the specified CORS configuration.
@Nullable Function<Resource,String>	getEtagGenerator()	Return the HTTP ETag generator function to be used when serving resources.
List<Resource>	getLocations()	Return the configured List of Resource locations including both String-based locations provided via setLocationValues and pre-resolved Resource locations provided via setLocations.
protected @Nullable MediaType	getMediaType(jakarta.servlet.http.HttpServletRequest request, Resource resource)	Determine the media type for the given request and the resource matched to it.
Map<String, MediaType>	getMediaTypes()	Return the configured media types.
protected @Nullable Resource	getResource(jakarta.servlet.http.HttpServletRequest request)
@Nullable ResourceHttpMessageConverter	getResourceHttpMessageConverter()	Return the configured resource converter.
@Nullable ResourceRegionHttpMessageConverter	getResourceRegionHttpMessageConverter()	Return the configured resource region converter.
List<ResourceResolver>	getResourceResolvers()	Return the list of configured resource resolvers.
List<ResourceTransformer>	getResourceTransformers()	Return the list of configured resource transformers.
@Nullable UrlPathHelper	getUrlPathHelper()	Deprecated, for removal: This API element is subject to removal in a future version. use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.
void	handleRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Processes a resource request.
protected void	initAllowedLocations()	Look for a PathResourceResolver among the configured resource resolvers and set its allowedLocations property (if empty) to match the locations configured on this class.
protected boolean	isInvalidPath(String path)	Invoked after ResourceHandlerUtils.isInvalidPath(String) to allow subclasses to perform further validation.
boolean	isOptimizeLocations()	Return 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.
boolean	isUseLastModified()	Return whether the Resource.lastModified() information is used to drive HTTP responses when serving static resources.
protected String	processPath(String path)	Process the given resource path.
void	setCorsConfiguration(CorsConfiguration corsConfiguration)	Specify the CORS configuration for resources served by this handler.
void	setEmbeddedValueResolver(StringValueResolver resolver)	Set the StringValueResolver to use for resolving embedded definition values.
void	setEtagGenerator(@Nullable 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.
protected void	setHeaders(jakarta.servlet.http.HttpServletResponse response, Resource resource, @Nullable MediaType mediaType)	Set headers on the given servlet response.
void	setLocations(List<Resource> locations)	Configure locations to serve resources from as pre-resourced Resource's.
void	setLocationValues(List<String> locations)	Configure String-based locations to serve resources from.
void	setMediaTypes(Map<String, MediaType> mediaTypes)	Add mappings between file extensions, extracted from the filename of a static Resource, and corresponding media type to set on the response.
void	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.
void	setResourceHttpMessageConverter(@Nullable ResourceHttpMessageConverter messageConverter)	Configure the ResourceHttpMessageConverter to use.
void	setResourceRegionHttpMessageConverter(@Nullable ResourceRegionHttpMessageConverter messageConverter)	Configure the ResourceRegionHttpMessageConverter to use.
void	setResourceResolvers(@Nullable List<ResourceResolver> resourceResolvers)	Configure the list of ResourceResolvers to use.
void	setResourceTransformers(@Nullable List<ResourceTransformer> resourceTransformers)	Configure the list of ResourceTransformers to use.
void	setUrlPathHelper(@Nullable UrlPathHelper urlPathHelper)	Deprecated, for removal: This API element is subject to removal in a future version. use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.
void	setUseLastModified(boolean useLastModified)	Set whether we should look at the Resource.lastModified() when serving resources and use this information to drive "Last-Modified" HTTP response headers.
String	toString()

Methods inherited from class WebContentGenerator

applyCacheControl, applyCacheSeconds, checkRequest, getAllowHeader, getCacheControl, getCacheSeconds, getSupportedMethods, getVaryByRequestHeaders, isRequireSession, prepareResponse, setCacheControl, setCacheSeconds, setRequireSession,