[jboss-cvs] JBossAS SVN: r105324 - in projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US: fallback_content and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Fri May 28 01:06:57 EDT 2010
Author: rebecca_newton
Date: 2010-05-28 01:06:56 -0400 (Fri, 28 May 2010)
New Revision: 105324
Modified:
projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Book_Info.xml
projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Inside_Applications.xml
projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Shared_Installation.xml
projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Using_The_Deployer.xml
projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/fallback_content/section-Acknowledgements.xml
projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/section-Section_A.xml
projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/section-Section_B.xml
Log:
Edit
Modified: projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Book_Info.xml
===================================================================
--- projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Book_Info.xml 2010-05-28 03:45:53 UTC (rev 105323)
+++ projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Book_Info.xml 2010-05-28 05:06:56 UTC (rev 105324)
@@ -4,7 +4,7 @@
%BOOK_ENTITIES;
]>
<bookinfo id="book-JBoss_Sample_Project-JBoss_Sample_Project">
- <title>Spring Use Guide</title>
+ <title>Spring Installation Guide</title>
<subtitle>Using Certified Versions of Spring on JBoss Platforms</subtitle>
<productname>Documentation</productname>
<productnumber>0.1</productnumber>
Modified: projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Inside_Applications.xml
===================================================================
--- projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Inside_Applications.xml 2010-05-28 03:45:53 UTC (rev 105323)
+++ projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Inside_Applications.xml 2010-05-28 05:06:56 UTC (rev 105324)
@@ -5,27 +5,34 @@
%BOOK_ENTITIES;
]>
<chapter id="Inside_Applications">
- <title>Packaging Spring inside Applications</title>
+ <title>Packaging Spring Inside Applications</title>
- <para>The other option, which also is the one most frequently employed by
- application packagers, is to package Spring inside the deployed application.
- In order to do so, the application must deploy the files:<itemizedlist>
- <listitem>
- <para>for WARs: in the WEB-INF/lib folder;</para>
- </listitem>
+ <para> The option most frequently employed by application packagers is to package Spring inside the deployed application. In order to do so, the application must deploy the files:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term> For WARS </term>
+ <listitem>
+ <para>In the <filename>WEB-INF/lib</filename> folder;</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term> For EARS </term>
+ <listitem>
+ <para>In the <filename>/lib</filename> folder of the archive, or another folder,
+ as indicated by the <filename>META-INF/application.xml</filename> descriptor;</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term> For RARS </term>
+ <listitem>
+ <para>In the archive itself.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
- <listitem>
- <para>for EARs: in the /lib folder of the archive, or another folder,
- as indicated by the META-INF/application.xml descriptor;</para>
- </listitem>
-
- <listitem>
- <para>for RARs: in the archive itself.</para>
- </listitem>
- </itemizedlist></para>
-
<para>For EARs that contain WARs, Spring can be packaged either in the
- shared library folder of the EAR, or in the WEB-INF/lib folder of each
+ shared library folder of the EAR, or in the <filename>WEB-INF/lib</filename> folder of each
individual WAR that uses it. Unless the WARs use different versions of
Spring (a rare occurence), it is advisable to package Spring as a shared
library of the EAR.</para>
@@ -40,29 +47,29 @@
<itemizedlist>
<listitem>
- <para>every deployed application can use a different version of
+ <para>Every deployed application can use a different version of
Spring, if necessary;</para>
</listitem>
<listitem>
- <para>build scripts are, in general simpler;</para>
+ <para>Build scripts are generally simpler;</para>
</listitem>
<listitem>
- <para>packaged applications can be deployed on any server instance
+ <para>Packaged applications can be deployed on any server instance
(the target server does not need to be prepared beforehand);</para>
</listitem>
</itemizedlist>
<para>On the other hand, the main disadvantages are:<itemizedlist>
<listitem>
- <para>an increased size for each deployed application;</para>
+ <para>An increased size for each deployed application;</para>
</listitem>
<listitem>
- <para>memory usage for due to classloading is not very efficient:
+ <para>Memory usage due to classloading is not very efficient:
classes which are common to all applications are loaded multiple
- times;</para>
+ times.</para>
</listitem>
</itemizedlist></para>
Modified: projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Shared_Installation.xml
===================================================================
--- projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Shared_Installation.xml 2010-05-28 03:45:53 UTC (rev 105323)
+++ projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Shared_Installation.xml 2010-05-28 05:06:56 UTC (rev 105324)
@@ -15,17 +15,17 @@
the relative advantages and disadvantages of this strategy. </para>
<section>
- <title>The installation process</title>
+ <title>The Installation Process</title>
- <para>One can install Spring as a shared library by copying it either in
+ <para>You can install Spring as a shared library by copying it either in
the common library directory of the application server
- (JBOSS_HOME/common/lib) or into one of the library directory of one of the
- individual profiles (JBOSS_HOME/server/<profile-name>/lib). Of the
+ (<filename>JBOSS_HOME/common/lib</filename>) or into one of the library directory of one of the
+ individual profiles (<filename>JBOSS_HOME/server/<profile-name>/lib</filename>). Of the
two, copying the Spring libraries in the common library directory of the
application server is the most typical way of sharing them, because it
affects all configurations. However, if necessary, it is possible to share
the libraries only for a specific configuration, as described
- above.</para>
+ previously.</para>
<simplesect>
<title>Determining the JARs that need to be copied</title>
@@ -37,26 +37,25 @@
</simplesect>
<simplesect>
- <title>Implications on packaging the application</title>
+ <title>Implications of packaging the application</title>
<para>If Spring libraries are installed as shared libraries inside the
application server, they do not need to be included in the deployed
applications anymore, as that may lead to classloading errors. </para>
- <para>For Ant builds, this means that the war or ear tasks must not
- include the spring libraries in the <lib/> element.</para>
+ <para>For Ant builds, this means that the WAR or EAR tasks must not
+ include the Spring libraries in the <lib/> element.</para>
- <para>Maven builds can use the </para>
</simplesect>
- <simplesect>
+ <simplesect id="Overriding_the_shared_version_of_Spring">
<title>Overriding the shared version of Spring</title>
<para>From time to time, a deployed application may need a different
version of Spring than the shared one. In such cases, an application may
decide to package its own version of Spring, and take advantage of the
- Java EE classloader hierarchy rules, which give precedence to classes
- packaged with the application. For doing so, the application must
+ Java EE classloader hierarchy rules. These rules give precedence to classes
+ packaged with the application. To do so, the application must
include all the Spring libraries it requires (otherwise, related classes
will be loaded from different classloaders).</para>
</simplesect>
@@ -70,17 +69,17 @@
<itemizedlist>
<listitem>
- <para>reduces the size of the packaged applications that will be
+ <para>Reduces the size of the packaged applications that will be
deployed (EARs, WARs, RARs);</para>
</listitem>
<listitem>
- <para>reduces the number of times Spring classes are loaded by the
+ <para>Reduces the number of times Spring classes are loaded by the
various classloaders, and thus </para>
</listitem>
<listitem>
- <para>provides a simple path to upgrade to a different version of the
+ <para>Provides a simple path to upgrade to a different version of the
Spring Framework (a single place to do the replacement).</para>
</listitem>
</itemizedlist>
@@ -90,26 +89,34 @@
same application server instance. The main drawbacks and caveats of this
approach are:</para>
- <itemizedlist>
- <listitem>
- <para>consistency issues: assumes that all applications which are
- deployed on the application server are compatible with the same
- version of Spring and can be upgraded at the same time;</para>
- </listitem>
-
- <listitem>
- <para>build requirements: all applications deployed on the server must
+ <variablelist>
+ <varlistentry>
+ <term> Consistency issues </term>
+ <listitem>
+ <para>Assumes all applications that are deployed on the application server
+ are compatible with the same version of Spring and can be upgraded at the same
+ time;
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term> Build Requirements </term>
+ <listitem>
+ <para>All applications deployed on the server must
be built in a way that does not package Spring, or if they do, they
- follow the rules described in the "Overriding the shared version of
- Spring" section above;</para>
- </listitem>
-
- <listitem>
- <para>operational issues: installing the shared Spring libraries
- becomes part of the application server setup - the packaged
+ follow the rules described in <xref linkend="Overriding_the_shared_version_of_Spring"/>;
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term> Operational Issues </term>
+ <listitem>
+ <para>Installing the shared Spring libraries
+ becomes part of the application server setup; the packaged
applications will not contain the Spring libraries, and won't run on a
- server that does not contain them;</para>
- </listitem>
- </itemizedlist>
+ server that does not contain them.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
</chapter>
Modified: projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Using_The_Deployer.xml
===================================================================
--- projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Using_The_Deployer.xml 2010-05-28 03:45:53 UTC (rev 105323)
+++ projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/Using_The_Deployer.xml 2010-05-28 05:06:56 UTC (rev 105324)
@@ -17,12 +17,12 @@
<itemizedlist>
<listitem>
- <para>shared through the common library folder of the application
+ <para>Shared through the common library folder of the application
server;</para>
</listitem>
<listitem>
- <para>packaged inside the deployer.</para>
+ <para>Packaged inside the deployer.</para>
</listitem>
</itemizedlist>
@@ -42,8 +42,7 @@
<para>For packaging the Spring libraries inside the deployer, they need to
be copied in
- JBOSS_HOME/server/<configuration>/deployers/spring.deployer (e.g.
- JBOSS_HOME/server/default/deployers/spring.deployer).</para>
+ <filename>JBOSS_HOME/server/<configuration>/deployers/spring.deployer</filename> (for example <filename>JBOSS_HOME/server/default/deployers/spring.deployer</filename>).</para>
<para>For Spring 2.5.6.SEC01 you need to package the following Spring
jars:</para>
@@ -84,11 +83,11 @@
<simplesect>
<title>Deploying Spring together with the Spring deployment</title>
- <para>If the Spring deployment also contains the Spring libraries packaged
- (as in the Sportsclub example), it is important make sure that all the
+ <para>If the Spring deployment also contains the Spring libraries packaged,
+ it is important make sure that all the
Spring classes used by the application (directly or indirectly) are
included, in order to avoid classloading issues. However, if Spring is
deployed in the common library folder, then it doesn't need to be packaged
- in neither the deployer, nor the application.</para>
+ in either the deployer, or the application.</para>
</simplesect>
</chapter>
Modified: projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/fallback_content/section-Acknowledgements.xml
===================================================================
--- projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/fallback_content/section-Acknowledgements.xml 2010-05-28 03:45:53 UTC (rev 105323)
+++ projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/fallback_content/section-Acknowledgements.xml 2010-05-28 05:06:56 UTC (rev 105324)
@@ -5,8 +5,8 @@
]>
<section>
<title>Acknowledgements</title>
- <para>Many thanks to the following Red Hat Engineering Content Services contributors for adding valuable content to this reference.</para>
- <para>Darrin Mison contributed the base technical information for <xref linkend="iim-Interop_Install_Maven"/>, and <xref linkend="pwj-Publish_With_jDocBook"/>.</para>
+ <para>Many thanks to the following Red Hat Engineering Content Services contributors for adding valuable content to this reference.</para>
+ <para>Darrin Mison contributed the base technical information for <xref linkend="iim-Interop_Install_Maven"/>, and <xref linkend="pwj-Publish_With_jDocBook"/>.</para>
<para>Sean Rogers contributed heavily to <xref linkend="sg-Structure_Guidelines"/> with reworked and detailed XML element guidelines from the ECS wiki. These guidelines were originally written by David O'Brien.</para>
<para>Many thanks to Ruediger Landmann and the Publican Team for allowing us to directly include <xref linkend="sect-Users_Guide-Disallowed_elements_and_attributes-Disallowed_attributes"/>, <xref linkend="sect-Users_Guide-Disallowed_elements_and_attributes-Disallowed_elements"/>, and <xref linkend="sge-Structure_Guidlines_Entities"/> from the Publican User Guide. </para>
</section>
Modified: projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/section-Section_A.xml
===================================================================
--- projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/section-Section_A.xml 2010-05-28 03:45:53 UTC (rev 105323)
+++ projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/section-Section_A.xml 2010-05-28 05:06:56 UTC (rev 105324)
@@ -12,12 +12,11 @@
<itemizedlist>
<listitem>
- <para>downloading it from the Spring Framework site
- (http://www.springsource.org/downloads/community);</para>
+ <para>Downloading it from the <ulink url="http://www.springsource.org/download">Spring Framework</ulink> site;</para>
</listitem>
<listitem>
- <para>downloading it from a public repository (Maven or Ivy).</para>
+ <para>Downloading it from a public repository (Maven or Ivy).</para>
</listitem>
</itemizedlist>
@@ -34,11 +33,7 @@
</itemizedlist>
<para>Instructions on how to download and to set up repositories for using
- the community versions of Spring can be found in the Spring Reference
- documentation
- (http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/overview.html#dependency-management).
- While the instructions above have been written taking Spring 3 into
- consideration, they are applicable to version 2.5.6.SEC01 as well.</para>
+ the community versions of Spring can be found in the <ulink url="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/overview.html#dependency-management"> Spring Reference documentation </ulink>. While the instructions above have been written taking Spring 3 into consideration, they are applicable to version 2.5.6.SEC01 as well.</para>
<simplesect>
<title>How to find the Spring JARs in a downloaded distribution</title>
@@ -48,13 +43,13 @@
frameworks. A significant portion of these dependencies are already
provided by JBoss. The scope of this document encompasses only the Spring
JARs and a few special dependencies. The Spring JARs can be found in the
- dist/ folder of the downloaded distribution for both the 2.5.6.SEC01 and
+ <filename>dist/</filename> folder of the downloaded distribution for both the 2.5.6.SEC01 and
3.0.2.RELEASE distributions.</para>
<para>Other dependencies potentially requred by the Spring Framework and
provided by the Spring distribution are the AOP Alliance APIs and AspectJ
(if using AspectJ in your applications). In general, the AOP Alliance APIs
are required even by transaction management scenarios, so it is a good
- idea to include deploy them as well.</para>
+ idea to include them as well.</para>
</simplesect>
</section>
Modified: projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/section-Section_B.xml
===================================================================
--- projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/section-Section_B.xml 2010-05-28 03:45:53 UTC (rev 105323)
+++ projects/docs/enterprise/WFK/Spring_Installation_Guide/en-US/section-Section_B.xml 2010-05-28 05:06:56 UTC (rev 105324)
@@ -8,17 +8,17 @@
<title>Packaging Options</title>
<para>When using the Spring Framework in an application, one problem that is
- oftenly encountered is how to package and distribute the framework. The main
+ often encountered is how to package and distribute the framework. The main
options are:</para>
<itemizedlist>
<listitem>
- <para>installing the framework libraries as shared libraries on the
+ <para>Installing the framework libraries as shared libraries on the
platform;</para>
</listitem>
<listitem>
- <para>packaging the framework libraries together with the
+ <para>Packaging the framework libraries together with the
application.</para>
</listitem>
</itemizedlist>
More information about the jboss-cvs-commits
mailing list