Packaging Facelets files (templates, includes, composites) in a JAR

by

You can put common resources in the /META-INF/resources folder of the JAR which is to be treated like as /WEB-INF/resources folder of the WAR.

E.g.

CommonWebProject
 |-- META-INF
 |    |-- resources
 |    |    `-- common
 |    |         |-- css
 |    |         |    `-- some.css
 |    |         |-- js
 |    |         |    `-- some.js
 |    |         |-- images
 |    |         |    `-- some.png
 |    |         |-- components
 |    |         |    `-- somecomposite.xhtml
 |    |         |-- someinclude.xhtml
 |    |         `-- sometemplate.xhtml
 |    |-- faces-config.xml
 |    `-- MANIFEST.MF
 :

The resources of the JAR are then available as follows:

<... xmlns:common="http://xmlns.jcp.org/jsf/composite/common/components">
<h:outputStylesheet library="common" name="css/some.css" />
<h:outputScript library="common" name="js/some.js" />
<h:graphicImage library="common" name="images/some.png" />
<common:somecomposite />
<ui:include src="https://stackoverflow.com/common/someinclude.xhtml" />
<ui:composition template="/common/sometemplate.xhtml" />
...

If you want to trigger the JSF2 annotation scanner as well so that you can put @ManagedBean, @FacesValidator, @FacesConverter and consorts in that project as well, then create a JSF2 compatible /META-INF/faces-config.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<faces-config
    xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd"
    version="2.0">
</faces-config>

The Facelets resource resolver is only necessary if the resources are not in /META-INF/resources for some reason, or when you’re not using Servlet 3.0 but 2.5, or when you’re using an early JBoss/JSF version which has bugs in META-INF resource resolving. See also How to create a modular JSF 2.0 application? for a concrete example.

More Related Contents:

  1. JSTL in JSF2 Facelets… makes sense?
  2. JSF returns blank/unparsed page with plain/raw XHTML/XML/EL source instead of rendered HTML output
  3. How to include another XHTML in XHTML using JSF 2.0 Facelets?
  4. How to reference CSS / JS / image resource in Facelets template?
  5. Why do I need to nest a component with rendered=”#{some}” in another component when I want to ajax-update it?
  6. Which XHTML files do I need to put in /WEB-INF and which not?
  7. Obtaining Facelets templates/files from an external filesystem or database
  8. How can I set id of a component/tag inside ui:repeat
  9. How to create a custom Facelets tag?
  10. Avoiding duplicate ids when reusing facelets compositions in the same naming container
  11. How to implement a dynamic list with a JSF 2.0 Composite Component?
  12. Error Parsing /page.xhtml: Error Traced[line: 42] The entity “nbsp” was referenced, but not declared
  13. Java EE6> Packaging JSF facelets (xhtml) and ManagedBeans as JAR
  14. Why is the getter called so many times by the rendered attribute?
  15. Does it matter whether place f:event inside f:metadata or not?
  16. Differences between action and actionListener
  17. How to use PrimeFaces p:fileUpload? Listener method is never invoked or UploadedFile is null / throws an error / not usable
  18. Difference between h:button and h:commandButton
  19. What URL to use to link / navigate to other JSF pages
  20. How to update Mojarra version in GlassFish
  21. @Inject to pass params to a CDI @Named bean via URL
  22. How to use Facelets composition with files from another context
  23. Changing JSF prefix to suffix mapping forces me to reapply the mapping on CSS background images
  24. Adding faces message to redirected page using ExternalContext.redirect()
  25. Reset input fields without executing validation
  26. Primefaces valueChangeListener or
  27. h:commandButton not working inside h:dataTable
  28. Redirect in @PostConstruct causes IllegalStateException
  29. Is Facelets page generated to Servlet as JSP generated to Servlet
  30. Skip required validation and invoke the application

Leave a Comment