11:54 p.m.
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.xml
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/gettingstarted.xml
===================================================================
--- 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="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="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 injecting
<literal>javax.jms.Session</literal> to specify transacted and acknowledgement
type:
+ <programlisting role="Java">
+@Inject @JmsSession(transacted=true, acknowledgementType=Session.CLIENT_ACKNOWLEDGE)
Session s;
+</programlisting>
+ </tip>
+ -->
+
+ <section id="injection.destination-based">
+ <title>Destination Based Injection</title>
+
+ <para>
+ The injection of resources that are themselves a
<literal>javax.jms.Destination</literal> or require one needs
+ a hint: What destination do you want to work with? This is provided by the
+ <literal>@JmsDestination</literal> annotatation.
+
+ <programlisting role="Java">
+@Inject @JmsDestination(jndiName="jms/MyTopic") Topic t;
+@Inject @JmsDestination(jndiName="jms/MyQueue") Queue
q;</programlisting>
+ </para>
+
+ <para>
+ You should create your own qualifier to provide type safe injection of
predefined destinations:
+ <programlisting role="Java">
+@Qualifier
+@JmsDestination(jndiName = "jms/MyTopic")
+public @interface MyTopic {}</programlisting>
+ </para>
+
+ <para>
+ You can then use it in place of the
<literal>@JmsDestination</literal> qualifier anywhere it's required:
+
+ <programlisting role="Java">
+@Inject @MyTopic TopicPublisher myPub;</programlisting>
+ </para>
+ </section>
+ </section>
+
+ <section id="routing-egress">
+ <title>Routing Events over JMS</title>
+
+ <para>TODO</para>
+ </section>
</chapter>
Copied: modules/jms/trunk/docs/reference/src/main/docbook/en-US/installation.xml (from rev
12692, modules/jms/trunk/docs/reference/src/main/docbook/en-US/gettingstarted.xml)
===================================================================
--- modules/jms/trunk/docs/reference/src/main/docbook/en-US/installation.xml
(rev 0)
+++ modules/jms/trunk/docs/reference/src/main/docbook/en-US/installation.xml 2010-05-07
04:54:44 UTC (rev 12695)
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="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="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="http://maven.apache.org/">Maven
+ </ulink>
+ as your build tool use the following dependency:
+ </para>
+
+ <programlisting role="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 valid version
of Seam JMS.</para>
+ </tip>
+</chapter>
Modified: modules/jms/trunk/docs/reference/src/main/docbook/en-US/intro.xml
===================================================================
--- 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
===================================================================
--- 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="http://www.w3.org/2001/XInclude"
href="book_info.xml" />
<toc />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="intro.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="installation.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="gettingstarted.xml" />
</book>