Module org.omnifaces

Package org.omnifaces.resourcehandler

Class CDNResource

java.lang.Object

jakarta.faces.application.ViewResource

jakarta.faces.application.Resource

jakarta.faces.application.ResourceWrapper

org.omnifaces.resourcehandler.RemappedResource

org.omnifaces.resourcehandler.CDNResource

All Implemented Interfaces:

FacesWrapper<Resource>, Externalizable, Serializable

public class CDNResource
extends RemappedResource

This Resource implementation is a marker class which signals that the given resource is served from a CDN host. It offers a method to return the local URL which can be used as fallback in case the CDN request errors out.

It is intended to be returned by a ResourceHandler which you write yourself and which uploads your own resources to your own CDN host, so that the CDN content stays byte for byte identical to the local content. The CombinedResourceHandler will then render an onerror handler which falls back to the local URL, and the CorsAwareResourceRenderer will then render the integrity attribute.

The CDNResourceHandler does not return this type, it returns a RemappedResource. Its CDN URLs point to third party hosts whose content is not byte for byte identical to the local content, and an integrity hash computed from the local content would therefore cause the browser to block the resource.

Since:

2.7

Author:

Bauke Scholtz

See Also:

• CDNResourceHandler
• CombinedResourceHandler
• CorsAwareResourceRenderer
• Serialized Form

Field Summary

Fields inherited from class jakarta.faces.application.Resource

COMPONENT_RESOURCE_KEY

Constructor Summary

Constructors

Constructor	Description
CDNResource()	Do not use this constructor.
CDNResource(Resource resource, String cdnURL)	Constructs a new CDN resource which remaps the given wrapped resource to the given CDN URL.

Method Summary

Modifier and Type	Method	Description
String	getLocalRequestPath()	Returns the local URL.
String	getRequestPath()	Returns the CDN URL.

Methods inherited from class org.omnifaces.resourcehandler.RemappedResource

equals, getContentType, getInputStream, getLibraryName, getResourceName, getResponseHeaders, getURL, getWrapped, hashCode, readExternal, setLibraryName, setResourceName, userAgentNeedsUpdate, writeExternal

Methods inherited from class jakarta.faces.application.ResourceWrapper

setContentType

Methods inherited from class jakarta.faces.application.Resource

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CDNResource

public CDNResource()

Do not use this constructor. It's merely there for Externalizable.

CDNResource

public CDNResource(Resource resource,
 String cdnURL)

Constructs a new CDN resource which remaps the given wrapped resource to the given CDN URL. The CDN URL is available by getRequestPath(). The local URL is available by getLocalRequestPath().

Parameters:

resource - The resource to be remapped.

cdnURL - The CDN URL of the resource.

Method Details

getRequestPath

public String getRequestPath()

Returns the CDN URL. I.e. the remapped request path pointing a CDN host.

Overrides:

getRequestPath in class RemappedResource

Returns:

The CDN URL.

getLocalRequestPath

public String getLocalRequestPath()

Returns the local URL. I.e. the original request path pointing the local host.

Returns:

The local URL.