How to reference JSF managed beans which are provided in a JAR file?

by

You need to have a JSF 2.0 compliant /META-INF/faces-config.xml file in the commons-web-1.0.jar file in order to get JSF to scan the JAR file for classes with JSF annotations like @ManagedBean and auto-register them.

<?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>

JSF does namely not scan every class of every single JAR file in the classpath, that would have been too expensive. Only JARs with the above /META-INF/faces-config.xml file will be scanned.

You should also ensure that you do not have the metadata-complete="true" attribute in the <faces-config> declaration of webapp’s own /WEB-INF/faces-config.xml file, otherwise JSF will assume that this faces config is complete and therefore won’t auto-scan JAR files for annotations.

If none of those conditions are (or can be) met, then you need to manually register the bean as <managed-bean> in webapp’s own /WEB-INF/faces-config.xml instead of relying on annotations.

See also chapter 11.4.2 of JSF 2.0 specification (emphasis mine).

11.4.2 Application Startup Behavior

…

This algorithm provides considerable flexibility for developers that are assembling the components of a JSF-based web
application. For example, an application might include one or more custom UIComponent implementations, along with
associated Renderers, so it can declare them in an application resource named “/WEB-INF/faces-config.xml”
with no need to programmatically register them with Application instance. In addition, the application might choose
to include a component library (packaged as a JAR file) that includes a “META-INF/faces-config.xml” resource.
The existence of this resource causes components, renderers, and other JSF implementation classes that are stored in this
library JAR file to be automatically registered, with no action required by the application.

More Related Contents:

  1. How to save state when extending UIComponentBase
  2. how to share a jsf error page between multiple wars
  3. Migrating from JSF 1.2 to JSF 2.0
  4. How to make an executable JAR file?
  5. How do I read a resource file from a Java jar file?
  6. What is a fat JAR? [duplicate]
  7. Call “java -jar MyFile.jar” with additional classpath option
  8. Controlling Maven final name of jar artifact
  9. Recommended JSF 2.0 CRUD frameworks [closed]
  10. How to write a Java program which can extract a JAR file and store its data in specified directory (location)?
  11. How to create and handle composite primary key in JPA
  12. How to use .jar files in NetBeans?
  13. Eclipse: Attach source/javadoc to a library via a local property
  14. Multiple runnable classes inside JAR, how to run them?
  15. Understanding JSF as a MVC framework
  16. What is the best way to avoid maven-jar?
  17. How do I use the Jersey JSON POJO support?
  18. Finding unused jars used in an eclipse project
  19. CDI: beans.xml, where do I put you?
  20. play .wav file from jar as resource using java
  21. How to include local jar files in Maven project [duplicate]
  22. Is there a way to run a method/class only on Tomcat/Wildfly/Glassfish startup?
  23. Accessing JAR resources
  24. Adding 3rd party jars to WEB-INF/lib automatically using Eclipse/Tomcat
  25. Java – Loading dlls by a relative path and hide them inside a jar
  26. Besides EAR and EJB, what do I get from a Java EE app server that I don’t get in a servlet container like Tomcat?
  27. How do I compile a java file that has jar dependencies?
  28. Java 11 package javax.xml.soap does not exist [duplicate]
  29. JAX-WS vs. JAX-RPC
  30. Why do we use web.xml? [closed]

Leave a Comment