Class PathResourceResolver

Constructor Detail

• PathResourceResolver

  public PathResourceResolver()

Method Detail

• setAllowedLocations

  public void setAllowedLocations​(Resource... locations)

  By default when a Resource is found, the path of the resolved resource is compared to ensure it's under the input location where it was found. However sometimes that may not be the case, e.g. when CssLinkResourceTransformer resolves public URLs of links it contains, the CSS file is the location and the resources being resolved are css files, images, fonts and others located in adjacent or parent directories.

  This property allows configuring a complete list of locations under which resources must be so that if a resource is not under the location relative to which it was found, this list may be checked as well.

  By default ResourceHttpRequestHandler initializes this property to match its list of locations.

  Parameters:

  locations - the list of allowed locations

  Since:

  4.1.2

  See Also:

  ResourceHttpRequestHandler.initAllowedLocations()

• getAllowedLocations

  public Resource[] getAllowedLocations()

• setLocationCharsets

  public void setLocationCharsets​(Map<Resource,​Charset> locationCharsets)

  Configure charsets associated with locations. If a static resource is found under a URL resource location the charset is used to encode the relative path

  Note: the charset is used only if the urlPathHelper property is also configured and its urlDecode property is set to true.

  Since:

  4.3.13

• getLocationCharsets

  public Map<Resource,​Charset> getLocationCharsets()

  Return charsets associated with static resource locations.

  Since:

  4.3.13

• setUrlPathHelper

  public void setUrlPathHelper​(UrlPathHelper urlPathHelper)

  Provide a reference to the UrlPathHelper used to map requests to static resources. This helps to derive information about the lookup path such as whether it is decoded or not.

  Since:

  4.3.13

• getUrlPathHelper

  public UrlPathHelper getUrlPathHelper()

  The configured UrlPathHelper.

  Since:

  4.3.13

• resolveResourceInternal

  protected Resource resolveResourceInternal​(HttpServletRequest request,
                                             String requestPath,
                                             List<? extends Resource> locations,
                                             ResourceResolverChain chain)

  Specified by:

  resolveResourceInternal in class AbstractResourceResolver

• resolveUrlPathInternal

  protected String resolveUrlPathInternal​(String resourcePath,
                                          List<? extends Resource> locations,
                                          ResourceResolverChain chain)

  Specified by:

  resolveUrlPathInternal in class AbstractResourceResolver

• getResource

  protected Resource getResource​(String resourcePath,
                                 Resource location)
                          throws IOException

  Find the resource under the given location.

  The default implementation checks if there is a readable Resource for the given path relative to the location.

  Parameters:

  resourcePath - the path to the resource

  location - the location to check

  Returns:

  the resource, or null if none found

  Throws:

  IOException

• checkResource

  protected boolean checkResource​(Resource resource,
                                  Resource location)
                           throws IOException

  Perform additional checks on a resolved resource beyond checking whether the resources exists and is readable. The default implementation also verifies the resource is either under the location relative to which it was found or is under one of the allowed locations.

  Parameters:

  resource - the resource to check

  location - the location relative to which the resource was found

  Returns:

  "true" if resource is in a valid location, "false" otherwise.

  Throws:

  IOException

  Since:

  4.1.2