Top Description Interfaces Classes

module spring.webflux

Package org.springframework.web.reactive.resource

Annotations

@NonNullApi
@NonNullFields

Imports

org.springframework.lang.NonNullApi, .NonNullFields

Support classes for serving static resources.

Interface Summary

Modifier and Type	Interface and Description
public interface	HttpResource Extended interface for a `Resource` to be written to an HTTP response.
public interface	ResourceResolver A strategy for resolving a request to a server-side resource.
public interface	ResourceResolverChain A contract for invoking a chain of `ResourceResolvers` where each resolver is given a reference to the chain allowing it to delegate when necessary.
public interface	ResourceTransformer An abstraction for transforming the content of a resource.
public interface	ResourceTransformerChain A contract for invoking a chain of `ResourceTransformers` where each resolver is given a reference to the chain allowing it to delegate when necessary.
public interface	VersionStrategy A strategy to determine the version of a static resource and to apply and/or extract it from the URL path.

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractFileNameVersionStrategy Abstract base class for filename suffix based `VersionStrategy` implementations, e.g. "static/myresource-version.js"
public abstract class	AbstractPrefixVersionStrategy Abstract base class for `VersionStrategy` implementations that insert a prefix into the URL path, e.g. "version/static/myresource.js".
public abstract class	AbstractResourceResolver Base `ResourceResolver` providing consistent logging.
public class	CachingResourceResolver A `ResourceResolver` that resolves resources from a `Cache` or otherwise delegates to the resolver chain and caches the result.
public class	CachingResourceTransformer A `ResourceTransformer` that checks a `Cache` to see if a previously transformed resource exists in the cache and returns it if found, or otherwise delegates to the resolver chain and caches the result.
public class	ContentVersionStrategy A `VersionStrategy` that calculates a Hex MD5 hash from the content of the resource and appends it to the file name, e.g. `"styles/main-e36d2e05253c6c7085a91522ce43a0b4.css"`.
public class	CssLinkResourceTransformer A `ResourceTransformer` implementation that modifies links in a CSS file to match the public URL paths that should be exposed to clients (e.g. with an MD5 content-based hash inserted in the URL).
pack-priv class	DefaultResourceResolverChain Default immutable implementation of `ResourceResolverChain`.
pack-priv class	DefaultResourceTransformerChain Default immutable implementation of `ResourceTransformerChain`.
public class	EncodedResourceResolver Resolver that delegates to the chain, and if a resource is found, it then attempts to find an encoded (e.g. gzip, brotli) variant that is acceptable based on the "Accept-Encoding" request header.
public class	FixedVersionStrategy A `VersionStrategy` that relies on a fixed version applied as a request path prefix, e.g. reduced SHA, version name, release date, etc. This is useful for example when `ContentVersionStrategy` cannot be used such as when using JavaScript module loaders which are in charge of loading the JavaScript resources and need to know their relative paths.
public class	NoResourceFoundException Raised when `ResourceWebHandler` is mapped to the request but can not find a matching resource.
public class	PathResourceResolver A simple `ResourceResolver` that tries to find a resource under the given locations matching to the request path.
public abstract class	ResourceTransformerSupport A base class for a `ResourceTransformer` with an optional helper method for resolving public links within a transformed resource.
public class	ResourceUrlProvider A central component to use to obtain the public URL path that clients should use to access a static resource.
public class	ResourceWebHandler `HttpRequestHandler` that serves static resources in an optimized way according to the guidelines of Page Speed, YSlow, etc. The "locations" property takes a list of Spring `Resource` locations from which static resources are allowed to be served by this handler.
public class	TransformedResource An extension of `ByteArrayResource` that a `ResourceTransformer` can use to represent an original resource preserving all other information except the content.
public class	VersionResourceResolver Resolves request paths containing a version string that can be used as part of an HTTP caching strategy in which a resource is cached with a date in the distant future (e.g. 1 year) and cached until the version, and therefore the URL, is changed.
public class	WebJarsResourceResolver A `ResourceResolver` that delegates to the chain to locate a resource and then attempts to find a matching versioned resource contained in a WebJar JAR file.