[jboss-cvs] jboss-seam/doc/reference/en/modules ...
Peter Muir
peter at bleepbleep.org.uk
Tue Oct 2 11:42:05 EDT 2007
User: pmuir
Date: 07/10/02 11:42:05
Modified: doc/reference/en/modules dependencies.xml
Log:
JBSEAM-1958
Revision Changes Path
1.5 +972 -931 jboss-seam/doc/reference/en/modules/dependencies.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: dependencies.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/dependencies.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- dependencies.xml 6 Sep 2007 19:01:57 -0000 1.4
+++ dependencies.xml 2 Oct 2007 15:42:05 -0000 1.5
@@ -1,21 +1,28 @@
<chapter id="dependencies">
<title>Dependencies</title>
+ <section>
+ <title>Project Dependencies</title>
+
<para>
- This chapter both lists the compile-time and runtime dependencies for Seam. Where the scope is listed as
- <literal>ear</literal>, the library should be included in the /lib directory of your application's ear file.
- Where the scope is listed as <literal>war</literal>, the library should be placed in the
- <literal>/WEB-INF/lib</literal> directory of your application's war file. If no scope is listed, then
- the library is either a compile-time dependency only, or is generally included by the container.
- For brevity, the specific version numbers have been removed from the filenames on this page.
+ This section both lists the compile-time and runtime dependencies for Seam.
+ Where the type is listed as <literal>ear</literal>, the library should be
+ included in the /lib directory of your application's ear file. Where the
+ type is listed as <literal>war</literal>, the library should be placed in
+ the <literal>/WEB-INF/lib</literal> directory of your application's war
+ file. The scope of the dependency is either all, runtime or provided (by
+ JBoss AS 4.2).
</para>
- <sect1>
+ <para>
+ Up to date version information is not included in the docs, but is provided
+ in the <literal>/build/root.pom.xml</literal> Maven POM.
+ </para>
+
+ <section>
<title>Core</title>
<table>
- <title>Core dependencies</title>
-
<tgroup cols="4">
<colspec colnum="1" colwidth="4*" />
<colspec colnum="2" colwidth="2*" />
@@ -31,7 +38,7 @@
<para>Scope</para>
</entry>
<entry align="center">
- <para>Provided by JBoss AS 4.2.x</para>
+ <para>Type</para>
</entry>
<entry align="center">
<para>Notes</para>
@@ -46,10 +53,10 @@
<para><literal>commons-codec.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>yes</para>
+ <para>ear</para>
</entry>
<entry>
<para>Required by Seam Security when using Digest authentication.</para>
@@ -61,10 +68,10 @@
<para><literal>jboss-seam.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>all</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para>The core Seam library, always required.</para>
@@ -76,10 +83,10 @@
<para><literal>jboss-seam-debug.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Include during development when enabling Seam's debug feature</para>
@@ -91,10 +98,10 @@
<para><literal>jboss-seam-ioc.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Required when using Seam with Spring</para>
@@ -106,10 +113,10 @@
<para><literal>jboss-seam-pdf.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Required when using Seam's PDF features</para>
@@ -121,10 +128,10 @@
<para><literal>jboss-seam-remoting.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Required when using Seam Remoting</para>
@@ -136,10 +143,10 @@
<para><literal>jboss-seam-ui.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Required to use the Seam JSF controls</para>
@@ -151,13 +158,13 @@
<para><literal>jsf-api.jar</literal></para>
</entry>
<entry align="center">
- <para></para>
+ <para>provided</para>
</entry>
<entry align="center">
- <para>yes</para>
+ <para></para>
</entry>
<entry>
- <para>JSF Reference Implementation</para>
+ <para>JSF API</para>
</entry>
</row>
@@ -166,10 +173,10 @@
<para><literal>jsf-impl.jar</literal></para>
</entry>
<entry align="center">
- <para></para>
+ <para>provided</para>
</entry>
<entry align="center">
- <para>yes</para>
+ <para></para>
</entry>
<entry>
<para>JSF Reference Implementation</para>
@@ -181,10 +188,10 @@
<para><literal>jsf-facelets.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Facelets</para>
@@ -193,90 +200,13 @@
<row>
<entry>
- <para><literal>thirdparty.jar</literal></para>
- </entry>
- <entry align="center">
- <para></para>
- </entry>
- <entry align="center">
- <para>no</para>
- </entry>
- <entry>
- <para>Third party libraries, including:</para>
- <itemizedlist>
- <listitem>
- <para>
- ANTLR
- </para>
- </listitem>
- <listitem>
- <para>
- Java concurrency library
- </para>
- </listitem>
- <listitem>
- <para>
- Trove - high performance collections library
- </para>
- </listitem>
- <listitem>
- <para>
- Javassist - Java Bytecode Manipulation
- </para>
- </listitem>
- <listitem>
- <para>
- javax.xml packages
- </para>
- </listitem>
- <listitem>
- <para>
- CGLIB
- </para>
- </listitem>
- <listitem>
- <para>
- Apache Commons Collections
- </para>
- </listitem>
- <listitem>
- <para>
- Apache Log4J
- </para>
- </listitem>
- <listitem>
- <para>
- Apache Xerces
- </para>
- </listitem>
- <listitem>
- <para>
- DOM4J
- </para>
- </listitem>
- <listitem>
- <para>
- HSQLDB
- </para>
- </listitem>
- <listitem>
- <para>
- Quartz
- </para>
- </listitem>
- </itemizedlist>
- </entry>
- </row>
-
- <row>
- <entry>
<para><literal>urlrewrite.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>URL Rewrite library</para>
@@ -288,10 +218,10 @@
<para><literal>jcaptcha-all.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para>Required for Captcha support</para>
@@ -303,10 +233,10 @@
<para><literal>quartz.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>yes</para>
+ <para>ear</para>
</entry>
<entry>
<para>Required when you wish to use Quartz with Seam's asynchronous features</para>
@@ -317,9 +247,9 @@
</tgroup>
</table>
- </sect1>
+ </section>
- <sect1>
+ <section>
<title>RichFaces</title>
<table>
@@ -340,7 +270,7 @@
<para>Scope</para>
</entry>
<entry align="center">
- <para>Provided by JBoss AS 4.2.x</para>
+ <para>Type</para>
</entry>
<entry align="center">
<para>Notes</para>
@@ -355,10 +285,10 @@
<para><literal>richfaces-api.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>all</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para>
@@ -373,10 +303,10 @@
<para><literal>richfaces-impl.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Required to use RichFaces.</para>
@@ -388,10 +318,10 @@
<para><literal>richfaces-ui.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Required to use RichFaces. Provides all the UI components.</para>
@@ -401,9 +331,9 @@
</tbody>
</tgroup>
</table>
- </sect1>
+ </section>
- <sect1>
+ <section>
<title>Seam Mail</title>
<table>
@@ -424,7 +354,7 @@
<para>Scope</para>
</entry>
<entry align="center">
- <para>Provided by JBoss AS 4.2.x</para>
+ <para>Type</para>
</entry>
<entry align="center">
<para>Notes</para>
@@ -439,10 +369,10 @@
<para><literal>activation.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para>Required for attachment support</para>
@@ -454,10 +384,10 @@
<para><literal>mail.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para>Required for outgoing mail support</para>
@@ -469,13 +399,15 @@
<para><literal>mail-ra.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>compile only</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para></para>
</entry>
<entry>
<para>Required for incoming mail support</para>
+ <para>mail-ra.rar should be deployed to the application server
+ at runtime</para>
</entry>
</row>
@@ -484,22 +416,22 @@
<para><literal>jboss-seam-mail.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
- <para>Seam Mail core library</para>
+ <para>Seam Mail</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
- </sect1>
+ </section>
- <sect1>
+ <section>
<title>Seam PDF</title>
<table>
@@ -517,10 +449,10 @@
<para>Name</para>
</entry>
<entry align="center">
- <para>Scope</para>
+ <para>Type</para>
</entry>
<entry align="center">
- <para>Provided by JBoss AS 4.2.x</para>
+ <para>Scope</para>
</entry>
<entry align="center">
<para>Notes</para>
@@ -535,10 +467,10 @@
<para><literal>itext.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>PDF Library</para>
@@ -550,10 +482,10 @@
<para><literal>jfreechart.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Charting library</para>
@@ -565,10 +497,10 @@
<para><literal>jcommon.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Required by JFreeChart</para>
@@ -580,10 +512,10 @@
<para><literal>jboss-seam-pdf.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>Seam PDF core library</para>
@@ -593,9 +525,9 @@
</tbody>
</tgroup>
</table>
- </sect1>
+ </section>
- <sect1>
+ <section>
<title>JBoss Rules</title>
<para>
@@ -620,7 +552,7 @@
<para>Scope</para>
</entry>
<entry align="center">
- <para>Provided by JBoss AS 4.2.x</para>
+ <para>Type</para>
</entry>
<entry align="center">
<para>Notes</para>
@@ -635,10 +567,10 @@
<para><literal>antlr-runtime.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para>ANTLR Runtime Library</para>
@@ -650,10 +582,10 @@
<para><literal>core.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para>Eclipse JDT</para>
@@ -665,10 +597,10 @@
<para><literal>drools-compiler.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para></para>
@@ -680,10 +612,10 @@
<para><literal>drools-core.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para></para>
@@ -695,10 +627,10 @@
<para><literal>janino.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para></para>
@@ -710,10 +642,10 @@
<para><literal>mvel.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para></para>
@@ -724,9 +656,9 @@
</tgroup>
</table>
- </sect1>
+ </section>
- <sect1>
+ <section>
<title>JBPM</title>
<table>
@@ -747,7 +679,7 @@
<para>Scope</para>
</entry>
<entry align="center">
- <para>Provided by JBoss AS 4.2.x</para>
+ <para>Type</para>
</entry>
<entry align="center">
<para>Notes</para>
@@ -759,13 +691,13 @@
<row>
<entry>
- <para><literal>jbpm.jar</literal></para>
+ <para><literal>jbpm-jpdl.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para></para>
@@ -776,9 +708,9 @@
</tgroup>
</table>
- </sect1>
+ </section>
- <sect1>
+ <section>
<title>GWT</title>
<para>
@@ -803,7 +735,7 @@
<para>Scope</para>
</entry>
<entry align="center">
- <para>Provided by JBoss AS 4.2.x</para>
+ <para>Type</para>
</entry>
<entry align="center">
<para>Notes</para>
@@ -817,10 +749,10 @@
<para><literal>gwt-servlet.jar</literal></para>
</entry>
<entry align="center">
- <para>war</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>war</para>
</entry>
<entry>
<para>The GWT Servlet libs</para>
@@ -831,9 +763,9 @@
</tgroup>
</table>
- </sect1>
+ </section>
- <sect1>
+ <section>
<title>Spring</title>
<para>
@@ -858,7 +790,7 @@
<para>Scope</para>
</entry>
<entry align="center">
- <para>Provided by JBoss AS 4.2.x</para>
+ <para>Type</para>
</entry>
<entry align="center">
<para>Notes</para>
@@ -872,10 +804,10 @@
<para><literal>spring.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para>The Spring Framework library</para>
@@ -886,9 +818,9 @@
</tgroup>
</table>
- </sect1>
+ </section>
- <sect1>
+ <section>
<title>Groovy</title>
<para>
@@ -913,7 +845,7 @@
<para>Scope</para>
</entry>
<entry align="center">
- <para>Provided by JBoss AS 4.2.x</para>
+ <para>Type</para>
</entry>
<entry align="center">
<para>Notes</para>
@@ -927,10 +859,10 @@
<para><literal>groovy-all.jar</literal></para>
</entry>
<entry align="center">
- <para>ear</para>
+ <para>runtime</para>
</entry>
<entry align="center">
- <para>no</para>
+ <para>ear</para>
</entry>
<entry>
<para>The Groovy libs</para>
@@ -941,6 +873,115 @@
</tgroup>
</table>
- </sect1>
+ </section>
+ </section>
+
+ <section>
+ <title>Dependency Management using Maven</title>
+ </section>
+
+ <para>
+ Maven offers support for transitive dependency management and can be used
+ to manage the dependencies of your Seam project. You can use Maven Ant
+ Tasks to integrate Maven into your Ant build, or can use Maven to build and
+ deploy your project.
+ </para>
+
+ <para>
+ We aren't actually going to discuss how to use Maven here, but just run
+ over some basic POMs you could use.
+ </para>
+
+ <para>
+ Released versions of Seam are available in http://repository.jboss.org/maven2
+ and nightly snapshots are available in http://snapshots.jboss.org/maven2.
+ </para>
+
+ <para>
+ All the Seam artifacts are available in Maven:
+ </para>
+
+ <programlisting><![CDATA[<dependency>
+ <groupId>org.jboss.seam</groupId>
+ <artifactId>jboss-seam</artifactId>
+</dependency>]]></programlisting>
+
+<programlisting><![CDATA[<dependency>
+ <groupId>org.jboss.seam</groupId>
+ <artifactId>jboss-seam-ui</artifactId>
+</dependency>]]></programlisting>
+
+<programlisting><![CDATA[<dependency>
+ <groupId>org.jboss.seam</groupId>
+ <artifactId>jboss-seam-pdf</artifactId>
+</dependency>]]></programlisting>
+
+<programlisting><![CDATA[<dependency>
+ <groupId>org.jboss.seam</groupId>
+ <artifactId>jboss-seam-remoting</artifactId>
+</dependency>]]></programlisting>
+
+<programlisting><![CDATA[<dependency>
+ <groupId>org.jboss.seam</groupId>
+ <artifactId>jboss-seam-ioc</artifactId>
+</dependency>]]></programlisting>
+
+<programlisting><![CDATA[<dependency>
+ <groupId>org.jboss.seam</groupId>
+ <artifactId>jboss-seam-ioc</artifactId>
+</dependency>]]></programlisting>
+
+ <para>
+ This sample POM will give you Seam, JPA (provided by Hibernate) and
+ Hibernate Validator:
+ </para>
+
+<programlisting><![CDATA[<?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>
+ <groupId>org.jboss.seam.example/groupId>
+ <artifactId>my-project</artifactId>
+ <version>1.0</version>
+ <name>My Seam Project</name>
+ <packaging>jar</packaging>
+ <repositories>
+ <repository>
+ <id>repository.jboss.org</id>
+ <name>JBoss Repository</name>
+ <url>http://repository.jboss.org/maven2</url>
+ </repository>
+ </repositories>
+
+ <dependencies>
+
+ <dependency>
+ <groupId>org.hibernate</groupId>
+ <artifactId>hibernate-validator</artifactId>
+ <version>3.0.0.GA</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.hibernate</groupId>
+ <artifactId>hibernate-annotations</artifactId>
+ <version>3.3.0.ga</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.hibernate</groupId>
+ <artifactId>hibernate-entitymanager</artifactId>
+ <version>3.3.1.ga</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.jboss.seam</groupId>
+ <artifactId>jboss-seam</artifactId>
+ <version>2.0.0.GA</version>
+ </dependency>
+
+ </dependencies>
+
+</project>]]></programlisting>
</chapter>
More information about the jboss-cvs-commits
mailing list