Class ResourceHttpRequestHandler

Constructor Detail

• ResourceHttpRequestHandler

  public ResourceHttpRequestHandler()

Method Detail

• setLocationValues

  public void setLocationValues​(List<String> locationValues)

  An alternative to setLocations(List) that accepts a list of String-based location values, with support for UrlResource's (e.g. files or HTTP URLs) with a special prefix to indicate the charset to use when appending relative paths. For example "[charset=Windows-31J]https://example.org/path".

  Since:

  4.3.13

• setLocations

  public void setLocations​(List<Resource> locations)

  Set the List of Resource locations to use as sources for serving static resources.

  See Also:

  setLocationValues(List)

• getLocations

  public List<Resource> getLocations()

  Return the configured List of Resource locations.

  Note that if locationValues are provided, instead of loaded Resource-based locations, this method will return empty until after initialization via afterPropertiesSet().

  See Also:

  setLocationValues(java.util.List<java.lang.String>), setLocations(java.util.List<org.springframework.core.io.Resource>)

• setResourceResolvers

  public void setResourceResolvers​(List<ResourceResolver> resourceResolvers)

  Configure the list of ResourceResolvers to use.

  By default PathResourceResolver is configured. If using this property, it is recommended to add PathResourceResolver as the last resolver.

• getResourceResolvers

  public List<ResourceResolver> getResourceResolvers()

  Return the list of configured resource resolvers.

• setResourceTransformers

  public void setResourceTransformers​(List<ResourceTransformer> resourceTransformers)

  Configure the list of ResourceTransformers to use.

  By default no transformers are configured for use.

• getResourceTransformers

  public List<ResourceTransformer> getResourceTransformers()

  Return the list of configured resource transformers.

• setResourceHttpMessageConverter

  public void setResourceHttpMessageConverter​(ResourceHttpMessageConverter messageConverter)

  Configure the ResourceHttpMessageConverter to use.

  By default a ResourceHttpMessageConverter will be configured.

  Since:

  4.3

• getResourceHttpMessageConverter

  public ResourceHttpMessageConverter getResourceHttpMessageConverter()

  Return the configured resource converter.

  Since:

  4.3

• setResourceRegionHttpMessageConverter

  public void setResourceRegionHttpMessageConverter​(ResourceRegionHttpMessageConverter messageConverter)

  Configure the ResourceRegionHttpMessageConverter to use.

  By default a ResourceRegionHttpMessageConverter will be configured.

  Since:

  4.3

• getResourceRegionHttpMessageConverter

  public ResourceRegionHttpMessageConverter getResourceRegionHttpMessageConverter()

  Return the configured resource region converter.

  Since:

  4.3

• setContentNegotiationManager

  public void setContentNegotiationManager​(ContentNegotiationManager contentNegotiationManager)

  Configure a ContentNegotiationManager to help determine the media types for resources being served. If the manager contains a path extension strategy it will be checked for registered file extension.

  Since:

  4.3

• getContentNegotiationManager

  public ContentNegotiationManager getContentNegotiationManager()

  Return the configured content negotiation manager.

  Since:

  4.3

• setCorsConfiguration

  public void setCorsConfiguration​(CorsConfiguration corsConfiguration)

  Specify the CORS configuration for resources served by this handler.

  By default this is not set in which allows cross-origin requests.

• getCorsConfiguration

  public CorsConfiguration getCorsConfiguration​(HttpServletRequest request)

  Return the specified CORS configuration.

  Specified by:

  getCorsConfiguration in interface CorsConfigurationSource

  Returns:

  the associated CorsConfiguration, or null if none

• 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

• setEmbeddedValueResolver

  public void setEmbeddedValueResolver​(StringValueResolver resolver)

  Description copied from interface: EmbeddedValueResolverAware
  Set the StringValueResolver to use for resolving embedded definition values.

  Specified by:

  setEmbeddedValueResolver in interface EmbeddedValueResolverAware

• afterPropertiesSet

  public void afterPropertiesSet()
                          throws Exception

  Description copied from interface: InitializingBean
  Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

  This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

  Specified by:

  afterPropertiesSet in interface InitializingBean

  Throws:

  Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails for any other reason

• initAllowedLocations

  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.

• initContentNegotiationStrategy

  protected PathExtensionContentNegotiationStrategy initContentNegotiationStrategy()

  Initialize the content negotiation strategy depending on the ContentNegotiationManager setup and the availability of a ServletContext.

  See Also:

  ServletPathExtensionContentNegotiationStrategy, PathExtensionContentNegotiationStrategy

• handleRequest

  public void handleRequest​(HttpServletRequest request,
                            HttpServletResponse response)
                     throws ServletException,
                            IOException

  Processes a resource request.

  Checks for the existence of the requested resource in the configured list of locations. If the resource does not exist, a 404 response will be returned to the client. If the resource exists, the request will be checked for the presence of the Last-Modified header, and its value will be compared against the last-modified timestamp of the given resource, returning a 304 status code if the Last-Modified value is greater. If the resource is newer than the Last-Modified value, or the header is not present, the content resource of the resource will be written to the response with caching headers set to expire one year in the future.

  Specified by:

  handleRequest in interface HttpRequestHandler

  Parameters:

  request - current HTTP request

  response - current HTTP response

  Throws:

  ServletException - in case of general errors

  IOException - in case of I/O errors

• getResource

  protected Resource getResource​(HttpServletRequest request)
                          throws IOException

  Throws:

  IOException

• processPath

  protected String processPath​(String path)

  Process the given resource path.

  The default implementation replaces:

  • Backslash with forward slash.
  • Duplicate occurrences of slash with a single slash.
  • Any combination of leading slash and control characters (00-1F and 7F) with a single "/" or "". For example " / // foo/bar" becomes "/foo/bar".

  Since:

  3.2.12

• isInvalidPath

  protected boolean isInvalidPath​(String path)

  Identifies invalid resource paths. By default rejects:

  • Paths that contain "WEB-INF" or "META-INF"
  • Paths that contain "../" after a call to StringUtils.cleanPath(java.lang.String).
  • Paths that represent a valid URL or would represent one after the leading slash is removed.

  Note: this method assumes that leading, duplicate '/' or control characters (e.g. white space) have been trimmed so that the path starts predictably with a single '/' or does not have one.

  Parameters:

  path - the path to validate

  Returns:

  true if the path is invalid, false otherwise

  Since:

  3.0.6

• getMediaType

  protected MediaType getMediaType​(HttpServletRequest request,
                                   Resource resource)

  Determine the media type for the given request and the resource matched to it. This implementation tries to determine the MediaType based on the file extension of the Resource via ServletPathExtensionContentNegotiationStrategy.getMediaTypeForResource(org.springframework.core.io.Resource).

  Parameters:

  request - the current request

  resource - the resource to check

  Returns:

  the corresponding media type, or null if none found

• getMediaType

  @Deprecated
  protected MediaType getMediaType​(Resource resource)

  Deprecated.

  as of 4.3 this method is deprecated; please override getMediaType(HttpServletRequest, Resource) instead.
  Determine an appropriate media type for the given resource.

  Parameters:

  resource - the resource to check

  Returns:

  the corresponding media type, or null if none found

• setHeaders

  protected void setHeaders​(HttpServletResponse response,
                            Resource resource,
                            MediaType mediaType)
                     throws IOException

  Set headers on the given servlet response. Called for GET requests as well as HEAD requests.

  Parameters:

  response - current servlet response

  resource - the identified resource (never null)

  mediaType - the resource's media type (never null)

  Throws:

  IOException - in case of errors while setting the headers

• toString

  public String toString()

  Overrides:

  toString in class Object