public class ResourceUrlProvider extends java.lang.Object implements ApplicationListener<ContextRefreshedEvent>
This class is aware of Spring MVC handler mappings used to serve static
resources and uses the ResourceResolver
chains of the configured
ResourceHttpRequestHandler
s to make its decisions.
Modifier and Type | Field and Description |
---|---|
private boolean |
autodetect |
private java.util.Map<java.lang.String,ResourceHttpRequestHandler> |
handlerMap |
protected Log |
logger |
private PathMatcher |
pathMatcher |
private UrlPathHelper |
urlPathHelper |
Constructor and Description |
---|
ResourceUrlProvider() |
Modifier and Type | Method and Description |
---|---|
protected void |
detectResourceHandlers(ApplicationContext appContext) |
java.lang.String |
getForLookupPath(java.lang.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. |
java.lang.String |
getForRequestUrl(HttpServletRequest request,
java.lang.String requestUrl)
A variation on
getForLookupPath(String) that accepts a full request
URL path (i.e. |
java.util.Map<java.lang.String,ResourceHttpRequestHandler> |
getHandlerMap()
Return the resource mappings, either manually configured or auto-detected
when the Spring
ApplicationContext is refreshed. |
private int |
getLookupPathIndex(HttpServletRequest request) |
UrlPathHelper |
getPathHelper()
Deprecated.
as of Spring 4.2.8, in favor of
getUrlPathHelper() |
PathMatcher |
getPathMatcher()
Return the configured
PathMatcher . |
private int |
getQueryParamsIndex(java.lang.String lookupPath) |
UrlPathHelper |
getUrlPathHelper()
Return the configured
UrlPathHelper . |
boolean |
isAutodetect()
Return
false if resource mappings were manually configured,
true otherwise. |
void |
onApplicationEvent(ContextRefreshedEvent event)
Handle an application event.
|
void |
setHandlerMap(java.util.Map<java.lang.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 urlPathHelper)
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. |
protected final Log logger
private UrlPathHelper urlPathHelper
private PathMatcher pathMatcher
private final java.util.Map<java.lang.String,ResourceHttpRequestHandler> handlerMap
private boolean autodetect
public void setUrlPathHelper(UrlPathHelper urlPathHelper)
UrlPathHelper
to use in
#getForRequestUrl(javax.servlet.http.HttpServletRequest, String)
in order to derive the lookup path for a target request URL path.public UrlPathHelper getUrlPathHelper()
UrlPathHelper
.@Deprecated public UrlPathHelper getPathHelper()
getUrlPathHelper()
public void setPathMatcher(PathMatcher pathMatcher)
PathMatcher
to use when comparing target lookup path
against resource mappings.public PathMatcher getPathMatcher()
PathMatcher
.public void setHandlerMap(java.util.Map<java.lang.String,ResourceHttpRequestHandler> handlerMap)
Note: by default resource mappings are auto-detected
from the Spring ApplicationContext
. However if this property is
used, the auto-detection is turned off.
public java.util.Map<java.lang.String,ResourceHttpRequestHandler> getHandlerMap()
ApplicationContext
is refreshed.public boolean isAutodetect()
false
if resource mappings were manually configured,
true
otherwise.public void onApplicationEvent(ContextRefreshedEvent event)
ApplicationListener
onApplicationEvent
in interface ApplicationListener<ContextRefreshedEvent>
event
- the event to respond toprotected void detectResourceHandlers(ApplicationContext appContext)
public final java.lang.String getForRequestUrl(HttpServletRequest request, java.lang.String requestUrl)
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.request
- the current requestrequestUrl
- the request URL path to resolvenull
if unresolvedprivate int getLookupPathIndex(HttpServletRequest request)
private int getQueryParamsIndex(java.lang.String lookupPath)
public final java.lang.String getForLookupPath(java.lang.String lookupPath)
ResourceResolver
chain of the matched
ResourceHttpRequestHandler
to resolve the URL path to expose for
public use.
It is expected that the given path is what Spring MVC would use for request mapping purposes, i.e. excluding context and servlet path portions.
If several handler mappings match, the handler used will be the one configured with the most specific pattern.
lookupPath
- the lookup path to checknull
if unresolved