To use the Seam Faces module, you need to put the API and implementation JARs on the classpath of your web application. Most of the features of Seam Faces are enabled automatically when it's added to the classpath. Some extra configuration, covered below, is required if you are not using a Servlet 3-compliant container.

If you are using Maven as your build tool, you can add the following single dependency to your pom.xml file to include Seam Faces:

<dependency>

   <groupId>org.jboss.seam.faces</groupId>

   <artifactId>seam-faces</artifactId>

   <version>${seam.faces.version}</version>

</dependency>

        

Alternatively, you can use the API at compile time and only include the implementation at runtime. This protects you from inadvertently depending on an implementation class.

<dependency>

   <groupId>org.jboss.seam.faces</groupId>

   <artifactId>seam-faces-api</artifactId>

   <version>${seam.faces.version}</version>

   <scope>compile</scope>

</dependency>



<dependency>

   <groupId>org.jboss.seam.faces</groupId>

   <artifactId>seam-faces-impl</artifactId>

   <version>${seam.faces.version}</version>

   <scope>runtime</scope>

</dependency>

        

In a Servlet 3.0 or Java EE 6 environment, your configuration is now complete!

If you are using Java EE 5 or some other Servlet 2.5 container, then you need to manually register several Servlet components in your application's web.xml to activate the features provided by this module:

<listener>

   <listener-class>org.jboss.seam.faces.beanManager.BeanManagerServletContextListener</listener-class>

</listener>

        

You're now ready to dive into the JSF enhancements provided for you by the Seam Faces module!

Seam Faces requires a working JSF 2.0 configuration. To get a working JSF 2.0 environment in a Java EE 6 environment, you need one of the following:

The JBoss JSF documentation provides further details on #2 and #3 above, but these steps are unnecessary when you use Seam Faces (#1). this is because Seam Faces scans for the presence of the Seam Servlet, and programatically registers it for you if it's not present.