From seam-commits at lists.jboss.org Fri May  7 00:54:45 2010
Content-Type: multipart/mixed; boundary="===============0217643249961996160=="
MIME-Version: 1.0
From: seam-commits at lists.jboss.org
To: seam-commits at lists.jboss.org
Subject: [seam-commits] Seam SVN: r12695 -
 modules/jms/trunk/docs/reference/src/main/docbook/en-US.
Date: Fri, 07 May 2010 00:54:45 -0400
Message-ID: <201005070454.o474sjNv001375@svn01.web.mwc.hst.phx2.redhat.com>

--===============0217643249961996160==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: jganoff
Date: 2010-05-07 00:54:44 -0400 (Fri, 07 May 2010)
New Revision: 12695

Added:
   modules/jms/trunk/docs/reference/src/main/docbook/en-US/installation.xml
Modified:
   modules/jms/trunk/docs/reference/src/main/docbook/en-US/gettingstarted.x=
ml
   modules/jms/trunk/docs/reference/src/main/docbook/en-US/intro.xml
   modules/jms/trunk/docs/reference/src/main/docbook/en-US/master.xml
Log:
Updated documentation

Modified: modules/jms/trunk/docs/reference/src/main/docbook/en-US/gettingst=
arted.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- modules/jms/trunk/docs/reference/src/main/docbook/en-US/gettingstarted.=
xml	2010-05-07 03:50:12 UTC (rev 12694)
+++ modules/jms/trunk/docs/reference/src/main/docbook/en-US/gettingstarted.=
xml	2010-05-07 04:54:44 UTC (rev 12695)
@@ -23,30 +23,90 @@
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
    "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" []>
 <chapter id=3D"gettingstarted">
+   <title>Getting Started</title>
 =

-	<title>Getting started</title>
+   <para>
+      In this chapter we'll look at how to inject JMS resources and route =
events over JMS.
+   </para>
 =

-	<para>
-		In this chapter we'll look at how to setup a Maven project to use the
-		JMS module, how to inject JMS resources and how to route events over
-		JMS.
-	</para>
-	=

-	<section>
-		<title>Setting up a Maven project</title>
-		=

-		<para>TODO</para>
-	</section>
-	=

-	<section>
-		<title>Injection JMS Resources</title>
-		=

-		<para>TODO</para>
-	</section>
-	=

-	<section>
-		<title>Routing Events over JMS</title>
-		=

-		<para>TODO</para>
-	</section>
+   <section id=3D"injection">
+      <title>JMS Resource Injection</title>
+
+      <para>The following JMS resources are now available for injection:</=
para>
+
+      <itemizedlist>
+         <listitem>
+            javax.jms.Connection
+         </listitem>
+         <listitem>
+            javax.jms.Session
+         </listitem>
+      </itemizedlist>
+
+      <para>Destination-based resources:</para>
+      <itemizedlist>
+         <listitem>
+            javax.jms.Topic
+         </listitem>
+         <listitem>
+            javax.jms.Queue
+         </listitem>
+         <listitem>
+            javax.jms.TopicPublisher
+         </listitem>
+         <listitem>
+            javax.jms.QueueSender
+         </listitem>
+         <listitem>
+            javax.jms.TopicSubscriber
+         </listitem>
+         <listitem>
+            javax.jms.QueueReceiver
+         </listitem>
+      </itemizedlist>
+      =

+      <!-- TODO  Clean up and move elsewhere
+      <tip>
+      You can use the <literal>@JmsSession</literal> qualifier when inject=
ing <literal>javax.jms.Session</literal> to specify transacted and acknowle=
dgement type:
+      <programlisting role=3D"Java">
+(a)Inject @JmsSession(transacted=3Dtrue, acknowledgementType=3DSession.CLI=
ENT_ACKNOWLEDGE) Session s;
+</programlisting>
+      </tip>
+      -->
+
+      <section id=3D"injection.destination-based">
+         <title>Destination Based Injection</title>
+
+         <para>
+            The injection of resources that are themselves a <literal>java=
x.jms.Destination</literal> or require one needs
+            a hint:  What destination do you want to work with?  This is p=
rovided by the =

+            <literal>@JmsDestination</literal> annotatation.
+         =

+            <programlisting role=3D"Java">
+(a)Inject @JmsDestination(jndiName=3D"jms/MyTopic") Topic t;
+(a)Inject @JmsDestination(jndiName=3D"jms/MyQueue") Queue q;</programlisti=
ng>
+         </para>
+            =

+         <para>            =

+            You should create your own qualifier to provide type safe inje=
ction of predefined destinations:
+            <programlisting role=3D"Java">
+(a)Qualifier
+(a)JmsDestination(jndiName =3D "jms/MyTopic")
+public @interface MyTopic {}</programlisting>
+         </para>
+         =

+         <para>
+         You can then use it in place of the <literal>@JmsDestination</lit=
eral> qualifier anywhere it's required:
+
+         <programlisting role=3D"Java">
+(a)Inject @MyTopic TopicPublisher myPub;</programlisting>
+         </para>
+      </section>
+   </section>
+
+   <section id=3D"routing-egress">
+      <title>Routing Events over JMS</title>
+
+      <para>TODO</para>
+   </section>
 </chapter>

Copied: modules/jms/trunk/docs/reference/src/main/docbook/en-US/installatio=
n.xml (from rev 12692, modules/jms/trunk/docs/reference/src/main/docbook/en=
-US/gettingstarted.xml)
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- modules/jms/trunk/docs/reference/src/main/docbook/en-US/installation.xm=
l	                        (rev 0)
+++ modules/jms/trunk/docs/reference/src/main/docbook/en-US/installation.xm=
l	2010-05-07 04:54:44 UTC (rev 12695)
@@ -0,0 +1,48 @@
+<?xml version=3D"1.0" encoding=3D"UTF-8"?>
+<!--
+  JBoss, Home of Professional Open Source
+  Copyright 2010, Red Hat, Inc., and individual contributors
+  by the @authors tag. See the copyright.txt in the distribution for a
+  full listing of individual contributors.
+  =

+  This is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as
+  published by the Free Software Foundation; either version 2.1 of
+  the License, or (at your option) any later version.
+  =

+  This software is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+  =

+  You should have received a copy of the GNU Lesser General Public
+  License along with this software; if not, write to the Free
+  Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+  02110-1301 USA, or see the FSF site: http://www.fsf.org.
+-->
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" []>
+<chapter id=3D"installation">
+
+   <title>Installation</title>
+
+   <para>
+      Most features of Seam JMS are installed automatically by
+      including the seam-jms.jar in your application's library folder.
+      If you are using
+      <ulink
+         url=3D"http://maven.apache.org/">Maven
+         </ulink>
+      as your build tool use the following dependency:
+   </para>
+      =

+   <programlisting role=3D"XML"><![CDATA[<dependency>
+   <groupId>org.jboss.seam</groupId>
+   <artifactId>seam-jms</artifactId>
+   <version>${seam.jms.version}</version>
+</dependency>]]></programlisting>
+
+   <tip>
+      <para>Define or replace the property ${seam.jms.version} with a vali=
d version of Seam JMS.</para>
+   </tip>
+</chapter>

Modified: modules/jms/trunk/docs/reference/src/main/docbook/en-US/intro.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- modules/jms/trunk/docs/reference/src/main/docbook/en-US/intro.xml	2010-=
05-07 03:50:12 UTC (rev 12694)
+++ modules/jms/trunk/docs/reference/src/main/docbook/en-US/intro.xml	2010-=
05-07 04:54:44 UTC (rev 12695)
@@ -36,9 +36,9 @@
 		<title>Mission statement</title>
 =

 		<para>
-			The missing of the JMS module for Seam 3 is to provide injection
-			of JMS resources and the necessary scaffolding for CDI event
-			propagation over JMS.
+			The JMS module for Seam 3 is to provide injection of JMS resources =

+         and the necessary scaffolding for a bidirectional propagation of =

+         CDI event over JMS.
 		</para>
 	</section>
 =

@@ -47,7 +47,7 @@
 =

 		<para>
 			The general goals can be divided into two categories: injection
-			of JMS resources and forwarding of events:
+			of JMS resources and bridging of events:
 		</para>
 =

 		<itemizedlist>
@@ -70,12 +70,12 @@
 		</itemizedlist>
 =

 		<itemizedlist>
-			<title>Forwarding of Events</title>
+			<title>Event Bridge</title>
 			<listitem>
-				Implicit - use a stereotype annotation when firing events
+				Egress: Routes CDI events to JMS destinations
 			</listitem>
 			<listitem>
-				Explicit - events and qualifiers are registered explicitly
+				Ingress: Fires CDI events based on the reception of JMS messages
 			</listitem>
 		</itemizedlist>
 	</section>

Modified: modules/jms/trunk/docs/reference/src/main/docbook/en-US/master.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- modules/jms/trunk/docs/reference/src/main/docbook/en-US/master.xml	2010=
-05-07 03:50:12 UTC (rev 12694)
+++ modules/jms/trunk/docs/reference/src/main/docbook/en-US/master.xml	2010=
-05-07 04:54:44 UTC (rev 12695)
@@ -26,5 +26,6 @@
    <xi:include xmlns:xi=3D"http://www.w3.org/2001/XInclude" href=3D"book_i=
nfo.xml" />
    <toc />
    <xi:include xmlns:xi=3D"http://www.w3.org/2001/XInclude" href=3D"intro.=
xml" />
+   <xi:include xmlns:xi=3D"http://www.w3.org/2001/XInclude" href=3D"instal=
lation.xml" />
    <xi:include xmlns:xi=3D"http://www.w3.org/2001/XInclude" href=3D"gettin=
gstarted.xml" />
 </book>


--===============0217643249961996160==--