org.springframework.web.servlet.resource

Class ResourceUrlProvider

java.lang.Object

org.springframework.web.servlet.resource.ResourceUrlProvider

All Implemented Interfaces:

EventListener, ApplicationListener<ContextRefreshedEvent>

public class ResourceUrlProvider
extends Object
implements ApplicationListener<ContextRefreshedEvent>

A central component to use to obtain the public URL path that clients should use to access a static resource.

This class is aware of Spring MVC handler mappings used to serve static resources and uses the ResourceResolver chains of the configured ResourceHttpRequestHandlers to make its decisions.

Since:

4.1

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
protected Log	logger

Constructor Summary

Constructors

Constructor and Description
ResourceUrlProvider()

Method Summary

Modifier and Type	Method and Description
protected void	detectResourceHandlers(ApplicationContext appContext)
String	getForLookupPath(String lookupPath) Compare the given path against configured resource handler mappings and if a match is found use the ResourceResolver chain of the matched ResourceHttpRequestHandler to resolve the URL path to expose for public use.
String	getForRequestUrl(HttpServletRequest request, String requestUrl) A variation on getForLookupPath(String) that accepts a full request URL path (i.e.
Map<String,ResourceHttpRequestHandler>	getHandlerMap()
UrlPathHelper	getPathHelper()
PathMatcher	getPathMatcher()
boolean	isAutodetect()
void	onApplicationEvent(ContextRefreshedEvent event) Handle an application event.
void	setHandlerMap(Map<String,ResourceHttpRequestHandler> handlerMap) Manually configure the resource mappings.
void	setPathMatcher(PathMatcher pathMatcher) Configure a PathMatcher to use when comparing target lookup path against resource mappings.
void	setUrlPathHelper(UrlPathHelper pathHelper) Configure a UrlPathHelper to use in getForRequestUrl(javax.servlet.http.HttpServletRequest, String) in order to derive the lookup path for a target request URL path.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Log logger

Constructor Detail

ResourceUrlProvider

public ResourceUrlProvider()

Method Detail

setUrlPathHelper

public void setUrlPathHelper(UrlPathHelper pathHelper)

Configure a UrlPathHelper to use in getForRequestUrl(javax.servlet.http.HttpServletRequest, String) in order to derive the lookup path for a target request URL path.

getPathHelper

public UrlPathHelper getPathHelper()

Returns:

the configured UrlPathHelper.

setPathMatcher

public void setPathMatcher(PathMatcher pathMatcher)

Configure a PathMatcher to use when comparing target lookup path against resource mappings.

getPathMatcher

public PathMatcher getPathMatcher()

Returns:

the configured PathMatcher.

setHandlerMap

public void setHandlerMap(Map<String,ResourceHttpRequestHandler> handlerMap)

Manually configure the resource mappings.

Note: by default resource mappings are auto-detected from the Spring ApplicationContext. However if this property is used, the auto-detection is turned off.

getHandlerMap

public Map<String,ResourceHttpRequestHandler> getHandlerMap()

Returns:

the resource mappings, either manually configured or auto-detected when the Spring ApplicationContext is refreshed.

isAutodetect

public boolean isAutodetect()

Returns:

false if resource mappings were manually configured, true otherwise.

onApplicationEvent

public void onApplicationEvent(ContextRefreshedEvent event)

Description copied from interface: ApplicationListener

Handle an application event.

Specified by:

onApplicationEvent in interface ApplicationListener<ContextRefreshedEvent>

Parameters:

event - the event to respond to

detectResourceHandlers

protected void detectResourceHandlers(ApplicationContext appContext)

getForRequestUrl

public final String getForRequestUrl(HttpServletRequest request,
                                     String requestUrl)

A variation on getForLookupPath(String) that accepts a full request URL path (i.e. including context and servlet path) and returns the full request URL path to expose for public use.

Parameters:

request - the current request

requestUrl - the request URL path to resolve

Returns:

the resolved public URL path or null if unresolved

getForLookupPath

public final String getForLookupPath(String lookupPath)

Compare the given path against configured resource handler mappings and if a match is found use the ResourceResolver chain of the matched ResourceHttpRequestHandler to resolve the URL path to expose for public use.

It is expected the given path is what Spring MVC would use for request mapping purposes, i.e. excluding context and servlet path portions.

Parameters:

lookupPath - the lookup path to check

Returns:

the resolved public URL path or null if unresolved