org.springframework.web.reactive.resource

Class PathResourceResolver

java.lang.Object

org.springframework.web.reactive.resource.AbstractResourceResolver

org.springframework.web.reactive.resource.PathResourceResolver

All Implemented Interfaces:

ResourceResolver

public class PathResourceResolver
extends AbstractResourceResolver

A simple ResourceResolver that tries to find a resource under the given locations matching to the request path.

This resolver does not delegate to the ResourceResolverChain and is expected to be configured at the end in a chain of resolvers.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private Resource[]	allowedLocations

Fields inherited from class org.springframework.web.reactive.resource.AbstractResourceResolver

logger

Constructor Summary

Constructors

Constructor and Description
PathResourceResolver()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkResource(Resource resource, Resource location) Perform additional checks on a resolved resource beyond checking whether the resources exists and is readable.
Resource[]	getAllowedLocations()
private <any>	getResource(java.lang.String resourcePath, java.util.List<? extends Resource> locations)
protected <any>	getResource(java.lang.String resourcePath, Resource location) Find the resource under the given location.
private boolean	isInvalidEncodedPath(java.lang.String resourcePath)
private boolean	isResourceUnderLocation(Resource resource, Resource location)
protected <any>	resolveResourceInternal(ServerWebExchange exchange, java.lang.String requestPath, java.util.List<? extends Resource> locations, ResourceResolverChain chain)
protected <any>	resolveUrlPathInternal(java.lang.String path, java.util.List<? extends Resource> locations, ResourceResolverChain chain)
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.

Methods inherited from class org.springframework.web.reactive.resource.AbstractResourceResolver

resolveResource, resolveUrlPath

Methods inherited from class java.lang.Object

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

Field Detail

allowedLocations

@Nullable
private Resource[] allowedLocations

Constructor Detail

PathResourceResolver

public PathResourceResolver()

Method Detail

setAllowedLocations

public void setAllowedLocations(@Nullable
                                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 ResourceWebHandler initializes this property to match its list of locations.

Parameters:

locations - the list of allowed locations

getAllowedLocations

@Nullable
public Resource[] getAllowedLocations()

resolveResourceInternal

protected <any> resolveResourceInternal(@Nullable
                                        ServerWebExchange exchange,
                                        java.lang.String requestPath,
                                        java.util.List<? extends Resource> locations,
                                        ResourceResolverChain chain)

Specified by:

resolveResourceInternal in class AbstractResourceResolver

resolveUrlPathInternal

protected <any> resolveUrlPathInternal(java.lang.String path,
                                       java.util.List<? extends Resource> locations,
                                       ResourceResolverChain chain)

Specified by:

resolveUrlPathInternal in class AbstractResourceResolver

getResource

private <any> getResource(java.lang.String resourcePath,
                          java.util.List<? extends Resource> locations)

getResource

protected <any> getResource(java.lang.String resourcePath,
                            Resource location)

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 empty Mono if none found

checkResource

protected boolean checkResource(Resource resource,
                                Resource location)
                         throws java.io.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:

java.io.IOException

isResourceUnderLocation

private boolean isResourceUnderLocation(Resource resource,
                                        Resource location)
                                 throws java.io.IOException

Throws:

java.io.IOException

isInvalidEncodedPath

private boolean isInvalidEncodedPath(java.lang.String resourcePath)