Skip to content

Commit

Permalink
SEAMFACES-66 rename seam-faces to seam-faces-impl
Browse files Browse the repository at this point in the history 
- also update the url in Maven POMs so it creates correct manifest entry
  • Loading branch information
@mojavelinux
mojavelinux committed Dec 11, 2010
1 parent bdbec77 commit ef1f90d
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 55 deletions.
16 changes: 15 additions & 1 deletion api/pom.xml
View file
@@ -1,3 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

Expand All @@ -9,10 +10,11 @@
</parent>

<artifactId>seam-faces-api</artifactId>
<version>3.0.0-SNAPSHOT</version>

<packaging>jar</packaging>
<name>Seam Faces Module API</name>
<!-- url required for JAR Manifest -->
<url>${project.parent.url}</url>

<dependencies>
<dependency>
Expand Down Expand Up @@ -61,6 +63,18 @@
<scope>provided</scope>
</dependency>
</dependencies>

<build>
<plugins>
<!-- No tests in the api, skip phase -->
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<skipTests>true</skipTests>
</configuration>
</plugin>
</plugins>
</build>

<profiles>
<profile>
Expand Down
94 changes: 72 additions & 22 deletions docs/reference/src/main/docbook/en-US/installation.xml
View file
Expand Up @@ -4,27 +4,77 @@
<chapter id="faces.installation">
<title>Installation</title>
<para>
Most features of Seam Faces are installed automatically by including the seam-faces.jar and seam-faces-api.jar
in the web application library folder. If you are using <ulink url="http://maven.apache.org/">Maven</ulink> as your build tool, you can add the
following dependency to your pom.xml file:
</para>
<programlisting role="XML"><![CDATA[<dependency>
<groupId>org.jboss.seam.faces</groupId>
<artifactId>seam-faces</artifactId>
<version>${seam-faces-version}</version>
</dependency>]]></programlisting>
<tip>
<para>Replace ${seam-faces-version} with the most recent or appropriate version of Seam Faces.</para>
</tip>
<para>
In a Servlet 3.0 or Java EE 6 environment, your configuration is now complete; however, if you are still using Servlet 2.5 or Java EE 5, then you
need to add the following code to your application's web.xml file:
</para>
<programlisting><![CDATA[<web-app>
<listener>
<listener-class>org.jboss.seam.faces.beanManager.BeanManagerServletContextListener</listener-class>
</listener>
</web-app>]]></programlisting>
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.
</para>

<section id="maven-dependencies">
<title>Maven dependency configuration</title>
<para>
If you are using <ulink url="http://maven.apache.org/">Maven</ulink> as your build tool, you can add the
following single dependency to your pom.xml file to include Seam Faces:
</para>
<programlisting role="XML"><![CDATA[<dependency>
<groupId>org.jboss.seam.faces</groupId>
<artifactId>seam-faces-impl</artifactId>
<version>${seam.faces.version}</version>
</dependency>]]></programlisting>
<tip>
<para>
Substitute the expression ${seam.faces.version} with the most recent or appropriate version of Seam Faces.
Alternatively, you can create a <ulink
href="http://www.sonatype.com/books/mvnref-book/reference/resource-filtering-sect-properties.html#resource-filtering-sect-user-defined">Maven
user-defined property</ulink> to satisfy this substitution so you can centrally manage the version.
</para>
</tip>
<para>
Alternatively, you can use the API at compile time and only include the implementation at runtime. This protects
you from inadvertantly depending on an implementation class.
</para>
<programlisting role="XML"><![CDATA[<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>]]></programlisting>
<para>
If you are deploying to a platform other than JBoss AS, you also need to add the JBoss Logging implementation (a
portable logging abstraction).
</para>
<programlisting role="XML"><![CDATA[<dependency>
<groupId>org.jboss.logging</groupId>
<artifactId>jboss-logging</artifactId>
<version>3.0.0.Beta4</version>
<scope>compile</scope>
</dependency>]]></programlisting>
<para>
In a Servlet 3.0 or Java EE 6 environment, <emphasis>your configuration is now complete!</emphasis>
</para>
</section>

<section id="pre-servlet-3">
<title>Pre-Servlet 3.0 configuration</title>
<para>
<emphasis>If you are using Java EE 5 or some other Servlet 2.5 container</emphasis>, then you need to manually
register several Servlet components in your application's web.xml to activate the features provided by this
module:
</para>
<programlisting role="XML"><![CDATA[<listener>
<listener-class>org.jboss.seam.faces.beanManager.BeanManagerServletContextListener</listener-class>
</listener>]]></programlisting>
</section>

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

<!--
<section id="configuration">
Expand Down Expand Up @@ -70,4 +120,4 @@
</para>
</section>
-->
</chapter>
</chapter>
11 changes: 5 additions & 6 deletions examples/short-ly/pom.xml
View file
Expand Up @@ -9,12 +9,11 @@
</parent>

<groupId>org.jboss.seam.faces</groupId>
<artifactId>seam-faces-examples-short-ly</artifactId>
<version>3.0.0-SNAPSHOT</version>
<artifactId>seam-faces-example-short-ly</artifactId>
<packaging>war</packaging>
<name>Seam Faces Example bit.ly clone with PrettyFaces</name>

<url>http://seamframework.org</url>
<name>Seam Faces Example: bit.ly clone with PrettyFaces</name>
<!-- url required for JAR Manifest -->
<url>${project.parent.url}</url>

<properties>
<hibernate.version>3.5.1-Final</hibernate.version>
Expand All @@ -23,7 +22,7 @@
<dependencies>
<dependency>
<groupId>org.jboss.seam.faces</groupId>
<artifactId>seam-faces</artifactId>
<artifactId>seam-faces-impl</artifactId>
<version>${project.version}</version>
</dependency>

Expand Down
8 changes: 5 additions & 3 deletions impl/pom.xml
View file
@@ -1,3 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

Expand All @@ -8,11 +9,12 @@
<relativePath>../pom.xml</relativePath>
</parent>

<artifactId>seam-faces</artifactId>
<version>3.0.0-SNAPSHOT</version>
<artifactId>seam-faces-impl</artifactId>

<packaging>jar</packaging>
<name>Seam Faces Module Core Implementation</name>
<name>Seam Faces Module Implementation</name>
<!-- url required for JAR Manifest -->
<url>${project.parent.url}</url>

<dependencies>
<dependency>
Expand Down
29 changes: 6 additions & 23 deletions pom.xml
View file
@@ -1,3 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

Expand All @@ -12,17 +13,15 @@
<version>3.0.0-SNAPSHOT</version>

<packaging>pom</packaging>
<name>Seam Faces Module Parent POM</name>
<name>Seam Faces Module Parent</name>

<prerequisites>
<maven>3.0</maven>
</prerequisites>

<description>
The Parent for Seam Faces Modules
</description>
<description>CDI integration and numerous other enhancements for JSF</description>

<url>http://www.seamframework.org</url>
<url>http://seamframework.org/Seam3/FacesModule</url>

<modules>
<module>api</module>
Expand All @@ -32,8 +31,7 @@
<properties>
<seam.version>3.0.0.b03</seam.version>
<seam.i18n.version>3.0.0.Alpha2</seam.i18n.version>
<jboss.javaee.version>1.0.0.Beta4</jboss.javaee.version>
<cdi-api.version>1.0-SP2</cdi-api.version>
<jboss.javaee.version>1.0.0.CR1</jboss.javaee.version>
<jsf-api.version>2.0</jsf-api.version>
</properties>

Expand Down Expand Up @@ -70,16 +68,10 @@

<dependency>
<groupId>org.jboss.seam.faces</groupId>
<artifactId>seam-faces</artifactId>
<artifactId>seam-faces-impl</artifactId>
<version>${project.version}</version>
</dependency>

<dependency>
<groupId>javax.enterprise</groupId>
<artifactId>cdi-api</artifactId>
<version>${cdi-api.version}</version>
</dependency>

<dependency>
<groupId>javax.faces</groupId>
<artifactId>jsf-api</artifactId>
Expand All @@ -103,15 +95,6 @@
<module>examples/short-ly</module>
</modules>
</profile>
<profile>
<id>arquillian-glassfish-embedded-30</id>
<dependencies>
<dependency>
<groupId>org.jboss.arquillian.container</groupId>
<artifactId>arquillian-glassfish-embedded-30</artifactId>
</dependency>
</dependencies>
</profile>
<profile>
<id>jboss-public-repository</id>
<!-- Repository is active unless explicitly disabled e.g. -P!jboss-public-repository -->
Expand Down

0 comments on commit ef1f90d

Please sign in to comment.