[jboss-cvs] JBossAS SVN: r104974 - in projects/snowdrop/examples/trunk/sportsclub/docs/guide: en-US and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed May 19 03:37:00 EDT 2010
Author: laubai
Date: 2010-05-19 03:37:00 -0400 (Wed, 19 May 2010)
New Revision: 104974
Added:
projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Feedback.xml
Modified:
projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Author_Group.xml
projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Book_Info.xml
projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Introduction.xml
projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Revision_History.xml
projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/UseCases.xml
projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/guide.ent
projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/guide.xml
projects/snowdrop/examples/trunk/sportsclub/docs/guide/publican.cfg
Log:
Edited the introduction of the Sports Club example guide.
Modified: projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Author_Group.xml
===================================================================
--- projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Author_Group.xml 2010-05-19 06:29:41 UTC (rev 104973)
+++ projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Author_Group.xml 2010-05-19 07:37:00 UTC (rev 104974)
@@ -12,4 +12,12 @@
</affiliation>
<email>mariusb at redhat.com</email>
</author>
+ <editor>
+ <firstname>Laura</firstname>
+ <surname>Bailey</surname>
+ <affiliation>
+ <orgname>Red Hat</orgname>
+ </affiliation>
+ <email>lbailey at redhat.com</email>
+ </editor>
</authorgroup>
Modified: projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Book_Info.xml
===================================================================
--- projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Book_Info.xml 2010-05-19 06:29:41 UTC (rev 104973)
+++ projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Book_Info.xml 2010-05-19 07:37:00 UTC (rev 104974)
@@ -4,15 +4,16 @@
%BOOK_ENTITIES;
]>
<bookinfo id="book-guide-guide">
- <edition>0</edition>
- <title>Sports Club</title>
- <subtitle>An introduction to the JBoss and Spring integration example </subtitle>
- <productname>Documentation</productname>
- <productnumber>0.1</productnumber>
+ <title>Snowdrop Sports Club Example</title>
+ <subtitle>Integrating Spring with the JBoss Enterprise Platforms</subtitle>
+ <productname>JBoss Web Framework Kit</productname>
+ <productnumber>1.1</productnumber>
+ <edition>1.0</edition>
<pubsnumber>0</pubsnumber>
<abstract>
<para>
-A description of the Sports Club example, that illustrates a few JBoss and Spring integration use cases.</para>
+ This book provides a walkthrough of the JBoss Snowdrop Sports Club example. It illustrates several use cases for integrating the JBoss Enterprise Platforms with the Spring Framework.
+ </para>
</abstract>
<corpauthor>
<inlinemediaobject>
Added: projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Feedback.xml
===================================================================
--- projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Feedback.xml (rev 0)
+++ projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Feedback.xml 2010-05-19 07:37:00 UTC (rev 104974)
@@ -0,0 +1,23 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Snowdrop_1.0_User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section>
+ <title>We Need Feedback!</title>
+ <indexterm>
+ <primary>feedback</primary>
+ <secondary>contact information for this manual</secondary>
+ </indexterm>
+ <para>
+ If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA: <ulink url="http://jira.jboss.org/">http://jira.jboss.org/</ulink> against the product <application>JBoss Enterprise Application Platform</application> and component <emphasis>Documentation</emphasis>.
+ </para>
+ <para>
+ When submitting a bug report, be sure to mention the manual's identifier: &PRODUCT; <citetitle>Snowdrop Sports Club Example</citetitle>.
+ </para>
+ <para>
+ If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
+ </para>
+</section>
+
+
Modified: projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Introduction.xml
===================================================================
--- projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Introduction.xml 2010-05-19 06:29:41 UTC (rev 104973)
+++ projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Introduction.xml 2010-05-19 07:37:00 UTC (rev 104974)
@@ -6,26 +6,33 @@
]>
<chapter id="chap-guide-Test_Chapter">
<title>Introduction</title>
+
+ <para>
+ The Sports Club application provides a real world-inspired example of
+ integrating Spring with the JBoss Entprise Platforms. It consists of
+ three web applications, which illustrate several use cases through
+ various combinations of components and technologies. It also illustrates
+ how to use the Snowdrop libraries to provide JBoss-specific features,
+ such as creating a standalone deployment of an <classname>ApplicationContext</classname>
+ and injecting beans from that application context into non-Spring
+ components like Enterprise Java Beans (EJB).
+ </para>
- <para>The Sportsclub application provides a real-world inspired example on
- integrating Spring with Java EE 5 and JBoss. It consists of three web
- applications packaged together which illustrate various use cases and
- combinations of components and technologies. It also illustrates how to use
- the Snowdrop library in order to provide JBoss-specific integration
- features, such as standalone deployment of an ApplicationContext, and
- injection of beans provided from that application context in non-Spring
- components such as EJBs.</para>
+ <para>
+ This book aims to illustrate the mechanics of using Spring with different
+ Java EE 5 components in the specific context of the JBoss Enterprise Platforms,
+ and to recommend methods of achieving certain integration goals.
+ </para>
- <para>The main goal is to illustrate the mechanics of using Spring with
- different Java EE 5 components, in the specific context of JBoss, explaining
- why a certain approach is preferable to another, when the Spring Framework
- provides two or more options to achieving the same goal. For example, it
- will explain why we gave preference to JCA-based JMS integration over the
- DefaultMessageListenerContainer, or why we prefer to use an
- application-server deployed persistence context versus having Spring create
- one.</para>
+ <para>
+ The Sports Club example is not intended as a guide to creating a domain model.
+ Detailing the various layers of application and UI design is outside the scope
+ of this document. As such, the example application has been designed to
+ illustrate integration use cases, rather than to demonstrate a domain model
+ that strictly follows principles of object-oriented and domain-driven design.
+ </para>
- <para>The example is not intended to be a guide on creating a domain model,
+ <!--<para>The example is not intended to be a guide on creating a domain model,
breaking down the various layers of the application or on UI design. While
the domain model has attempted to follow the general priciples of
object-oriented and domain-driven design, which are commonly associated with
@@ -34,11 +41,13 @@
uses DAOs (or Repositories in DDD terms), but this shouldn't be viewed as
advocacy for using them in absolute terms. A significant number of Spring
applications use this particular design, and we have employed it to
- illustrate the technical integration use cases.</para>
+ illustrate the technical integration use cases.</para>-->
- <para>Also, the application uses RichFaces as a component library for JSF.
- We strongly encourage you to consult the Richfaces documentation and
- examples for Richfaces-specific information.</para>
+ <para>
+ The Sports Club example uses RichFaces as a component library for
+ JavaServer Faces (JSF). Consult the RichFaces documentation for RichFaces-specific
+ information.
+ </para>
<section>
<title>Prerequisites: making sure you have all you need</title>
Modified: projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Revision_History.xml
===================================================================
--- projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Revision_History.xml 2010-05-19 06:29:41 UTC (rev 104973)
+++ projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/Revision_History.xml 2010-05-19 07:37:00 UTC (rev 104974)
@@ -8,16 +8,16 @@
<simpara>
<revhistory>
<revision>
- <revnumber>1</revnumber>
- <date>Wed Feb 10 2010</date>
+ <revnumber>1.1</revnumber>
+ <date>Wed May 19 2010</date>
<author>
- <firstname>Marius</firstname>
- <surname>Bogoevici</surname>
- <email>mariusb at redhat.com</email>
+ <firstname>Laura</firstname>
+ <surname>Bailey</surname>
+ <email>lbailey at redhat.com</email>
</author>
<revdescription>
<simplelist>
- <member>Initial creation of book by publican</member>
+ <member>Edited book for stylistic consistency.</member>
</simplelist>
</revdescription>
</revision>
Modified: projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/UseCases.xml
===================================================================
--- projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/UseCases.xml 2010-05-19 06:29:41 UTC (rev 104973)
+++ projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/UseCases.xml 2010-05-19 07:37:00 UTC (rev 104974)
@@ -19,7 +19,11 @@
done for simplicity reasons, but also for demonstrating a few different
technologies and configuration options working side by side. </para>
- <para>The application supports the following scenarios:<itemizedlist>
+ <para>The business domain of the application is a Sports Club. The
+ employees of the club need to be able to perform the following
+ scenarios:</para>
+
+ <itemizedlist>
<listitem>
<para>maintaining informations about the subscribers, creating new
subcriptions and closing existing accounts;</para>
@@ -35,23 +39,35 @@
for accounts that do not have a current invoice and updating the
account whenever a payment has been received.</para>
</listitem>
- </itemizedlist></para>
+ </itemizedlist>
+ <para>As the concerns are different, we have three different
+ applications, each covering one piece of functionality.</para>
+
<para>Each of these scenarios is covered by a separate web application,
and all three applications are packaged in a single EAR file.</para>
- <para>Figure 2.1 shows how the application is structured:</para>
+ <para>The Reservations application is using the following
+ stack:</para>
+ <itemizedlist>
+ <listitem>
+ <para>UI layer implemented using Richfaces</para>
+ </listitem>
+<!-- Not sure what this is doing here...
+
<figure>
- <title>Structure of the Sportsclub application</title>
+ <title>Structure of the Sportsclub application</title>-->
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/application-modules.png" scale="80%" />
- </imageobject>
- </mediaobject>
- </figure>
+ <listitem>
+ <para>Persistence layer using Spring-based DAOs
+ (Hibernate/JPA)</para>
+ </listitem>
+ </itemizedlist>
+ <para>The Subscriptions application is using the following
+ stack:</para>
+
<para>All three applications share a common domain model and a common
DAO/repository layer, implemented using Spring. The application includes
both Hibernate and JPA implementations for the repository layer (using the
@@ -65,21 +81,35 @@
<para>The Subscriptions application uses an EJB-based service layer and a
JSF-based front-end, using Richfaces components. </para>
- <para>The Reservations application uses a Spring-based business layer and
- a JSF-based front-end, also using Richfaces components.</para>
+ <para>The Invoicing application is using the following stack:</para>
+ <itemizedlist>
+ <listitem>
+ <para>UI layer implemented using Spring MVC and JSP</para>
+ </listitem>
- <para>The Invoicing application uses an EJB service layer and a Spring
- MVC-based front-end (using JSP and Spring form tags). Apart from that, it
- demonstrates the creation of JAX-WS based web services injected with
- Spring beans, JCA-based Spring JMS integration, auditing by using the
- Spring AOP configuration and Spring JMX integration.</para>
+ <listitem>
+ <para>Business layer implemented using EJB</para>
+ </listitem>
+
+ <listitem>
+ <para>Persistence layer implemented using Spring-based DAOs
+ (Hibernate/JPA)</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>In all three cases, the persistence layer is implemented using
+ Spring. In fact there are two alternative implementations: one using
+ Hibernate directly and one using JPA (and Hibernate as the provider).
+ Building the application creates two different EAR files, one using the
+ JPA-based DAOs and one using the Hibernate-based DAOs.</para>
</section>
<section>
<title>A comparative look of the project modules</title>
- <para>All the modules (Maven artifacts) of the project, as well as the
- functionality that they cover are outlined in the following table:<table>
+ <para>The modules (Maven artifacts) of the project are outlined in the
+ following table:</para>
+ <table>
<title>Modules of the Sportsclub project</title>
<tgroup cols="3">
@@ -219,10 +249,6 @@
</row>
</tbody>
</tgroup>
- </table></para>
-
- <section>
- <para />
- </section>
+ </table>
</section>
</chapter>
Modified: projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/guide.ent
===================================================================
--- projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/guide.ent 2010-05-19 06:29:41 UTC (rev 104973)
+++ projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/guide.ent 2010-05-19 07:37:00 UTC (rev 104974)
@@ -1,4 +1,4 @@
-<!ENTITY PRODUCT "Documentation">
-<!ENTITY BOOKID "guide">
+<!ENTITY PRODUCT "JBoss Web Framework Kit">
+<!ENTITY BOOKID "Snowdrop_Sports_Club_Example">
<!ENTITY YEAR "2010">
-<!ENTITY HOLDER "Red Hat Inc.">
+<!ENTITY HOLDER "Red Hat, Inc">
Modified: projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/guide.xml
===================================================================
--- projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/guide.xml 2010-05-19 06:29:41 UTC (rev 104973)
+++ projects/snowdrop/examples/trunk/sportsclub/docs/guide/en-US/guide.xml 2010-05-19 07:37:00 UTC (rev 104974)
@@ -5,11 +5,9 @@
]>
<book>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/>
-
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Preface.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Introduction.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="UseCases.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Modules.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/>
- <index/>
</book>
Modified: projects/snowdrop/examples/trunk/sportsclub/docs/guide/publican.cfg
===================================================================
--- projects/snowdrop/examples/trunk/sportsclub/docs/guide/publican.cfg 2010-05-19 06:29:41 UTC (rev 104973)
+++ projects/snowdrop/examples/trunk/sportsclub/docs/guide/publican.cfg 2010-05-19 07:37:00 UTC (rev 104974)
@@ -1,7 +1,7 @@
# Config::Simple 4.59
# Wed Feb 10 13:45:26 2010
-xml_lang: en-US
+
type: Book
-brand: jboss-community
+brand: JBoss
docname: guide
More information about the jboss-cvs-commits
mailing list