public class CombinedResourceHandler extends ResourceHandlerWrapper implements SystemEventListener
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, when the JSF project stage is not set
to Development
.
To get it to run, this handler needs be registered as follows in faces-config.xml
:
<application> <resource-handler>org.omnifaces.resourcehandler.CombinedResourceHandler</resource-handler> </application>
Note that the target
attribute of <h:outputStylesheet>
already defaults to
"head"
but the one of <h:outputScript>
not. So if you have placed this inside the
<h:head>
, then you would still need to explicitly set its target
attribute to
"head"
, otherwise it will be treated as an inline script and not be combined. This is a design
limitation.
<h:head> <h:outputStylesheet name="style.css" /> <h:outputScript name="script.js" target="head" /> </h:head>
If you want them to appear after any auto-included resources, then move the declarations to the
<h:body>
.
<h:body> <h:outputStylesheet name="style.css" /> <h:outputScript name="script.js" target="head" /> </h:body>
The following context parameters are available:
"org.omnifaces.COMBINED_RESOURCE_HANDLER_EXCLUDED_RESOURCES"
|
Comma separated string of resource identifiers of <h:head> resources which needs to be excluded
from combining. For example:
<param-value>primefaces:primefaces.css, javax.faces:jsf.js</param-value> Any combined resource will be included after any of those excluded resources. |
"org.omnifaces.COMBINED_RESOURCE_HANDLER_SUPPRESSED_RESOURCES"
|
Comma separated string of resource identifiers of <h:head> resources which needs to be suppressed
and removed. For example:
<param-value>skinning.ecss, primefaces:jquery/jquery.js</param-value>
|
"org.omnifaces.COMBINED_RESOURCE_HANDLER_INLINE_CSS"
|
Set to true if you want to render the combined CSS resources inline (embedded in HTML) instead of as a
resource.
|
"org.omnifaces.COMBINED_RESOURCE_HANDLER_INLINE_JS"
|
Set to true if you want to render the combined JS resources inline (embedded in HTML) instead of as a
resource.
|
Here, the "resource identifier" is the unique combination of library name and resource name, separated by a colon,
exactly the syntax as you would use in #{resource}
in EL. If there is no library name, then just omit
the colon. Valid examples of resource identifiers are filename.ext
, folder/filename.ext
,
library:filename.ext
and library:folder/filename.ext
.
Note that this combined resource handler is not able to combine resources which are not
been added as a component resource, but are been hardcoded in some renderer (such as theme.css
in case
of PrimeFaces and several JavaScript files in case of RichFaces), or are been definied using plain HTML
<link>
or <script>
elements. Also, when you're using RichFaces with the context
parameter org.richfaces.resourceOptimization.enabled
set to true
, then the to-be-combined
resource cannot be resolved by a classpath URL due to RichFaces design limitations, so this combined resource handler
will use an internal workaround to get it to work anyway, but this involves firing a HTTP request for every resource.
The impact should however be relatively negligible as this is performed on localhost.
If you're also using the CDNResourceHandler
or, at least, have configured its context parameter
"org.omnifaces.CDN_RESOURCE_HANDLER_URLS", then those CDN resources will
automatically be added to the set of excluded resources.
Modifier and Type | Field and Description |
---|---|
static String |
LIBRARY_NAME
The default library name of a combined resource.
|
static String |
PARAM_NAME_EXCLUDED_RESOURCES
The context parameter name to specify resource identifiers which needs to be excluded from combining.
|
static String |
PARAM_NAME_INLINE_CSS
The context parameter name to enable rendering CSS inline instead of as resource link.
|
static String |
PARAM_NAME_INLINE_JS
The context parameter name to enable rendering JS inline instead of as resource link.
|
static String |
PARAM_NAME_SUPPRESSED_RESOURCES
The context parameter name to specify resource identifiers which needs to be suppressed and removed.
|
LOCALE_PREFIX, RESOURCE_EXCLUDES_DEFAULT_VALUE, RESOURCE_EXCLUDES_PARAM_NAME, RESOURCE_IDENTIFIER
Constructor and Description |
---|
CombinedResourceHandler(ResourceHandler wrapped)
Creates a new instance of this combined resource handler which wraps the given resource handler.
|
Modifier and Type | Method and Description |
---|---|
Resource |
createResource(String resourceName) |
Resource |
createResource(String resourceName,
String libraryName) |
Resource |
createResource(String resourceName,
String libraryName,
String contentType) |
ResourceHandler |
getWrapped() |
void |
handleResourceRequest(FacesContext context) |
boolean |
isListenerForSource(Object source)
Returns true if the source is an instance of
UIViewRoot . |
void |
processEvent(SystemEvent event)
Before rendering of a freshly created view, perform the following actions:
Collect all component resources from the head.
|
getRendererTypeForResourceName, isResourceRequest, libraryExists
public static final String LIBRARY_NAME
public static final String PARAM_NAME_EXCLUDED_RESOURCES
public static final String PARAM_NAME_SUPPRESSED_RESOURCES
public static final String PARAM_NAME_INLINE_CSS
public static final String PARAM_NAME_INLINE_JS
public CombinedResourceHandler(ResourceHandler wrapped)
Development
, then the initialization will be performed and this
will also register this resource handler as a pre render view event listener, so that it can do the job of
removing the CSS/JS resources and adding combined ones.wrapped
- The resource handler to be wrapped.public boolean isListenerForSource(Object source)
UIViewRoot
.isListenerForSource
in interface SystemEventListener
public void processEvent(SystemEvent event) throws AbortProcessingException
processEvent
in interface SystemEventListener
AbortProcessingException
public Resource createResource(String resourceName)
createResource
in class ResourceHandlerWrapper
public Resource createResource(String resourceName, String libraryName)
createResource
in class ResourceHandlerWrapper
public Resource createResource(String resourceName, String libraryName, String contentType)
createResource
in class ResourceHandlerWrapper
public void handleResourceRequest(FacesContext context) throws IOException
handleResourceRequest
in class ResourceHandlerWrapper
IOException
public ResourceHandler getWrapped()
getWrapped
in interface FacesWrapper<ResourceHandler>
getWrapped
in class ResourceHandlerWrapper