Top Description Fields Constructors Methods
org.springframework.web.reactive.resource

public abstract Class ResourceTransformerSupport

extends Object
implements ResourceTransformer
Class Inheritance
All Implemented Interfaces
org.springframework.web.reactive.resource.ResourceTransformer
Known Direct Subclasses
org.springframework.web.reactive.resource.CssLinkResourceTransformer
Imports
java.util.Collections, reactor.core.publisher.Mono, org.springframework.core.io.Resource, org.springframework.lang.Nullable, org.springframework.util.StringUtils, org.springframework.web.server.ServerWebExchange
A base class for a ResourceTransformer with an optional helper method for resolving public links within a transformed resource.
Authors
Rossen Stoyanchev, Brian Clozel
Since
5.0

Field Summary

Modifier and TypeField and Description
private ResourceUrlProvider
resourceUrlProvider

Constructor Summary

AccessConstructor and Description
public
ResourceTransformerSupport()

Method Summary

Modifier and TypeMethod and Description
public ResourceUrlProvider
getResourceUrlProvider()

Return the configured ResourceUrlProvider.

protected Mono<String>

Returns:

the resolved URL or an empty Mono
resolveUrlPath(String
the path to a resource that needs to be re-written
resourcePath, ServerWebExchange
the current exchange
exchange, Resource
the resource being transformed
resource, ResourceTransformerChain
the transformer chain
transformerChain)

A transformer can use this method when a resource being transformed contains links to other resources.

public void
setResourceUrlProvider(ResourceUrlProvider
the URL provider to use
resourceUrlProvider)

Configure a ResourceUrlProvider to use when resolving the public URL of links in a transformed resource (e.g. import links in a CSS file).

protected String

Returns:

the absolute request path for the given resource path
toAbsolutePath(String
the relative path to transform
path, ServerWebExchange
the current exchange
exchange)

Transform the given relative request path to an absolute path, taking the path of the given request as a point of reference.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

resourceUrlProviderback to summary
private ResourceUrlProvider resourceUrlProvider
Annotations
@Nullable

Constructor Detail

ResourceTransformerSupportback to summary
public ResourceTransformerSupport()

Method Detail

getResourceUrlProviderback to summary
public ResourceUrlProvider getResourceUrlProvider()

Return the configured ResourceUrlProvider.

Annotations
@Nullable
resolveUrlPathback to summary
protected Mono<String> resolveUrlPath(String resourcePath, ServerWebExchange exchange, Resource resource, ResourceTransformerChain transformerChain)

A transformer can use this method when a resource being transformed contains links to other resources. Such links need to be replaced with the public facing link as determined by the resource resolver chain (e.g. the public URL may have a version inserted).

Parameters
resourcePath:String

the path to a resource that needs to be re-written

exchange:ServerWebExchange

the current exchange

resource:Resource

the resource being transformed

transformerChain:ResourceTransformerChain

the transformer chain

Returns:Mono<String>

the resolved URL or an empty Mono

setResourceUrlProviderback to summary
public void setResourceUrlProvider(ResourceUrlProvider resourceUrlProvider)

Configure a ResourceUrlProvider to use when resolving the public URL of links in a transformed resource (e.g. import links in a CSS file). This is required only for links expressed as full paths and not for relative links.

Parameters
resourceUrlProvider:ResourceUrlProvider

the URL provider to use

toAbsolutePathback to summary
protected String toAbsolutePath(String path, ServerWebExchange exchange)

Transform the given relative request path to an absolute path, taking the path of the given request as a point of reference. The resulting path is also cleaned from sequences like "path/..".

Parameters
path:String

the relative path to transform

exchange:ServerWebExchange

the current exchange

Returns:String

the absolute request path for the given resource path