public class CDNResourceHandler extends ResourceHandlerWrapper
ResourceHandler
implementation allows the developer to provide CDN URLs instead of the default local
URLs for JSF resources as provided by <h:outputScript>
, <h:outputStylesheet>
and <h:graphicImage>
.
To get it to run, this handler needs be registered as follows in faces-config.xml
:
<application> <resource-handler>org.omnifaces.resourcehandler.CDNResourceHandler</resource-handler> </application>
By default, it runs only when the current JSF project stage is not set to Development
.
To configure the CDN URLs, a "org.omnifaces.CDN_RESOURCE_HANDLER_URLS"
context parameter has to be provided wherein the CDN resources are been specified as a comma separated string of
libraryName:resourceName=http://cdn.example.com/url
key=value pairs. The key represents the default
JSF resource identifier and the value represents the full CDN URL, including the scheme. The CDN URL is not validated
by this resource handler, so you need to make absolutely sure yourself that it is valid. Here's an example:
<context-param> <param-name>org.omnifaces.CDN_RESOURCE_HANDLER_URLS</param-name> <param-value> js/script1.js=http://cdn.example.com/js/script1.js, somelib:js/script2.js=http://cdn.example.com/somelib/js/script2.js, otherlib:style.css=http://cdn.example.com/otherlib/style.css, images/logo.png=http://cdn.example.com/logo.png </param-value> </context-param>
With the above configuration, the following resources:
<h:outputScript name="js/script1.js" /> <h:outputScript library="somelib" name="js/script2.js" /> <h:outputStylesheet library="otherlib" name="style.css" /> <h:graphicImage name="images/logo.png" />
Will be rendered as:
<script type="text/javascript" src="http://cdn.example.com/js/script1.js"></script> <script type="text/javascript" src="http://cdn.example.com/somelib/js/script2.js"></script> <link type="text/css" rel="stylesheet" href="http://cdn.example.com/otherlib/style.css" /> <img src="http://cdn.example.com/logo.png" />
Note that you can also use this on resources provided as ResourceDependency
by the JSF implementation and/or
component libraries. For example, JSF's own javax.faces:jsf.js
resource which is been used by
<f:ajax>
can be provided by a CDN URL using the following syntax:
javax.faces:jsf.js=http://cdn.example.com/jsf.js
You can also use the wildcard syntax to map every single resource of a specific library to a common CDN URL. To
achieve that, just use *
as the sole resource name and make sure that the CDN URL ends with
/*
. Here's an example:
<context-param> <param-name>org.omnifaces.CDN_RESOURCE_HANDLER_URLS</param-name> <param-value>jquery-cdn:*=http://code.jquery.com/*</param-value> </context-param>With the above configuration, the following resources:
<h:outputScript library="jquery-cdn" name="jquery-1.9.1.js" /> <h:outputScript library="jquery-cdn" name="ui/1.10.3/jquery-ui.js" />
Will be rendered as:
<script type="text/javascript" src="http://code.jquery.com/jquery-1.9.1.js"></script> <script type="text/javascript" src="http://code.jquery.com/ui/1.10.3/jquery-ui.js"></script>
The CDN resource handler supports evaluating EL expessions in the CDN URL. Here's an example:
<context-param> <param-name>org.omnifaces.CDN_RESOURCE_HANDLER_URLS</param-name> <param-value>jquery-cdn:*=http://#{settings.jqueryCDN}/*</param-value> </context-param>
The EL expression is resolved on a per-request basis.
By default, the CDN resource handler runs only when the current JSF project stage is not set to
Development
. When you need to run it during Development
stage as well, then set the context
parameter "org.omnifaces.CDN_RESOURCE_HANDLER_ALWAYS_ENABLED" to true
.
<context-param> <param-name>org.omnifaces.CDN_RESOURCE_HANDLER_ALWAYS_ENABLED</param-name> <param-value>true</param-value> </context-param>
If you're also using the CombinedResourceHandler
, then you need to understand that CDN resources can
simply not be combined, as that would defeat the CDN purpose. The CombinedResourceHandler
will therefore
automatically exclude all CDN resources from combining.
Modifier and Type | Field and Description |
---|---|
static String |
PARAM_NAME_CDN_DEV_STAGE
The context parameter name to tell CDN resource handler to run during development stage as well.
|
static String |
PARAM_NAME_CDN_RESOURCES
The context parameter name to specify CDN URLs for the given resource identifiers.
|
LOCALE_PREFIX, RESOURCE_EXCLUDES_DEFAULT_VALUE, RESOURCE_EXCLUDES_PARAM_NAME, RESOURCE_IDENTIFIER
Constructor and Description |
---|
CDNResourceHandler(ResourceHandler wrapped)
Creates a new instance of this CDN resource handler which wraps the given resource handler.
|
Modifier and Type | Method and Description |
---|---|
Resource |
createResource(String resourceName)
Delegate to
createResource(String, String, String) with null as library name and content
type. |
Resource |
createResource(String resourceName,
String libraryName)
Delegate to
createResource(String, String, String) with null as content type. |
Resource |
createResource(String resourceName,
String libraryName,
String contentType)
Delegate to
createResource(String, String, String) of the wrapped resource handler. |
ResourceHandler |
getWrapped() |
getRendererTypeForResourceName, handleResourceRequest, isResourceRequest, libraryExists
public static final String PARAM_NAME_CDN_RESOURCES
public static final String PARAM_NAME_CDN_DEV_STAGE
public CDNResourceHandler(ResourceHandler wrapped)
Development
, then the CDN resources will be initialized
based on the "org.omnifaces.CDN_RESOURCE_HANDLER_URLS" context
parameter.wrapped
- The resource handler to be wrapped.IllegalArgumentException
- When the context parameter is missing or is in invalid format.public Resource createResource(String resourceName)
createResource(String, String, String)
with null
as library name and content
type.createResource
in class ResourceHandlerWrapper
public Resource createResource(String resourceName, String libraryName)
createResource(String, String, String)
with null
as content type.createResource
in class ResourceHandlerWrapper
public Resource createResource(String resourceName, String libraryName, String contentType)
createResource(String, String, String)
of the wrapped resource handler. If it returns
non-null
and the current JSF project stage is not set to Development
,
then the properties file will be consulted if any CDN URL is available for the given resource. If there is none,
then just return the JSF default resource, otherwise return a wrapped resource whose
Resource.getRequestPath()
returns the CDN URL as is been set in the
"org.omnifaces.CDN_RESOURCE_HANDLER_URLS" context parameter.createResource
in class ResourceHandlerWrapper
public ResourceHandler getWrapped()
getWrapped
in interface FacesWrapper<ResourceHandler>
getWrapped
in class ResourceHandlerWrapper