Module org.omnifaces

Package org.omnifaces.resourcehandler

Class Summary

Class	Description
CDNResource	This Resource implementation can be used as a marker class to signal the custom ResourceHandler such as CombinedResourceHandler that the given resource actually returns a CDN URL, and offers a method to return the local URL which can be used as fallback in case the CDN request errors out.
CDNResourceHandler	This ResourceHandler implementation allows the developer to provide external (CDN) URLs instead of the default local URLs for Faces resources.
CombinedResource	This Resource implementation holds all the necessary information about combined resources in order to properly serve combined resources on a single HTTP request.
CombinedResourceHandler	This ResourceHandler implementation will remove all separate script and stylesheet resources which have the target attribute set to "head" from the UIViewRoot and create a combined one for all scripts and another combined one for all stylesheets.
CombinedResourceInfo	This class is a wrapper which collects all combined resources and stores it in the cache.
CombinedResourceInfo.Builder	Use this builder to create an instance of combined resource info and put it in the cache if absent.
CombinedResourceInputStream	This InputStream implementation takes care that all in the constructor given resources are been read in sequence.
DefaultResourceHandler	A default ResourceHandler implementation which hooks on all three DefaultResourceHandler.createResource(String), DefaultResourceHandler.createResource(String, String) and DefaultResourceHandler.createResource(String, String, String) methods.
DynamicResource	This Resource implementation represents a cacheable dynamic resource which doesn't necessarily exist as a regular classpath resource.
GraphicResource	This Resource implementation is used by the GraphicImage component.
GraphicResourceHandler	This ResourceHandler implementation deals with GraphicResource requests.
OmniVersionResourceHandler	Appends OmniFaces version to resources with library name omnifaces.
PWAResourceHandler	This ResourceHandler generates the manifest.json and also an offline-aware sw.js based on any WebAppManifest found in the runtime classpath.
RemappedResource	This Resource implementation remaps the given resource to the given request path.
ResourceIdentifier	Convenience class to represent a resource identifier.
SourceMapResourceHandler	This ResourceHandler implementation will set the SourceMap response header with the correctly mapped request path to any discovered source map of any CSS and JS resource.
UnmappedResourceHandler	This ResourceHandler implementation allows the developer to map Faces resources on an URL pattern of /jakarta.faces.resource/* (basically, the value of ResourceHandler.RESOURCE_IDENTIFIER) without the need for an additional FacesServlet prefix or suffix URL pattern in the default produced resource URLs, such as /jakarta.faces.resource/faces/css/style.css or /jakarta.faces.resource/css/style.css.xhtml.
VersionedResourceHandler	Automatically adds version parameter with query string name v to all resource URLs so that the browser cache will be busted whenever the version parameter changes.
ViewResourceHandler	This ResourceHandler basically turns any concrete non-Facelets file into a Faces view, so that you can use EL expressions and even Faces components in them.
WebAppManifest	Please refer to PWAResourceHandler for usage instructions.
WebAppManifest.ImageResource	To be used in WebAppManifest.getIcons().
WebAppManifest.RelatedApplication	To be used in WebAppManifest.getRelatedApplications()
WebAppManifest.Screenshot	To be used in WebAppManifest.getScreenshots()
WebAppManifest.Shortcut	to be used WebAppManifest.getShortcuts()
WebAppManifest.Size	To be used in WebAppManifest.ImageResource.getSizes().

Enum Summary

Enum	Description
WebAppManifest.Category	Enumeration of categories, to be used in WebAppManifest.getCategories().
WebAppManifest.Dir	Enumeration of text direction types, to be used in WebAppManifest.getDir().
WebAppManifest.Display	Enumeration of display modes, to be used in WebAppManifest.getDisplay().
WebAppManifest.Orientation	Enumeration of orientation modes, to be used in WebAppManifest.getOrientation().
WebAppManifest.Platform	Enumeration of related application platforms, to be used in WebAppManifest.RelatedApplication.getPlatform().
WebAppManifest.ScreenshotFormFactor	A WebAppManifest.Screenshot form factor