myfaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mmarinsc...@apache.org
Subject svn commit: r547140 - /myfaces/orchestra/trunk/core/src/site/xdoc/installation.xml
Date Thu, 14 Jun 2007 06:08:34 GMT
Author: mmarinschek
Date: Wed Jun 13 23:08:33 2007
New Revision: 547140

URL: http://svn.apache.org/viewvc?view=rev&rev=547140
Log:
doc fixes

Modified:
    myfaces/orchestra/trunk/core/src/site/xdoc/installation.xml

Modified: myfaces/orchestra/trunk/core/src/site/xdoc/installation.xml
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core/src/site/xdoc/installation.xml?view=diff&rev=547140&r1=547139&r2=547140
==============================================================================
--- myfaces/orchestra/trunk/core/src/site/xdoc/installation.xml (original)
+++ myfaces/orchestra/trunk/core/src/site/xdoc/installation.xml Wed Jun 13 23:08:33 2007
@@ -25,7 +25,7 @@
                 Orchestra.
             </p>
             The installation guide will show you how
-			to setup a JPA entity manager (so you are working with the new JavaPersistence API standard),
+			to setup a JPA entity manager for Orchestra (so you are working with the new JavaPersistence
API standard),
             later a chapter explaining how to access Hibernate directly will be added.
 			<subsection name="Prerequisites">
 				<ul>
@@ -43,10 +43,11 @@
 
 					<li>and all their dependencies
 						<br/>
-						This might sound somehow vague, but
-						it depends on the JSF and JPA implementation. If you have to setup
+						This might sound somehow vague; however, the exact names of the necessary libraries
+						depends on the JSF and JPA implementation. If you have to setup
 						an application architecture like this from scratch it might be best to take a look
at our
-						examples package.
+						examples package, and there in the file "pom.xml" which includes a section on the
+                        necessary dependencies.
 					</li>
 				</ul>
 			</subsection>
@@ -135,7 +136,8 @@
 				</pre>
 				<p>Basically, all you need to do is copy this configuration segment and paste it
                     into your Spring configuration file. Then you'll need to adapt the settings
in the element
-                    entityManagerFactory - namely the jpaProperties.
+                    entityManagerFactory - namely the jpaProperties. For a more detailed
explanation, we have
+                    included the following instructions - it is not necessary to read through
them.
                 </p>
 				<ul>
 					<li>1. the conversation scope
@@ -164,46 +166,46 @@
 						Depending on the ORM
 						tool you want to use you will have to configure a persistenceContextFactory. Apache
 						MyFaces Orchestra will provide a JPA-based implementation in its core15
-						package. It is under discussion that these adapter classes might be moved
-						to the Spring framework eventually.
+						package. Eventually, these adapter classes might be moved
+						to the Spring framework.
 					</li>
 
 					<li>4.persistence
 						<br/>
-						This is one of the ways how to configure a
+						This is one of the ways how to configure an
 						entity manager factory and the persistence framework in Spring. You
 						can adapt this part as you like, just have a look at the Spring
-						documentation. For example, we use
-						<code>&lt;tx:annotation-driven/&gt;</code>
-						, if you have to stay with
-						Java 1.4 you can choose any other Spring configuration. Apache MyFaces
-						Orchestra DO NOT RELY on annotations. The above configuration is just the
-						one I used for our examples.
+						documentation. For our example, we use
+						<code>&lt;tx:annotation-driven/&gt;</code>, if you are using
+						Java 1.4 you can choose any other Spring based persistence configurations. One of
+                        the features of Apache MyFaces Orchestra is that
+                        Orchestra <b>does not rely</b> on annotations. The above
configuration is just the
+						one we used for our applications.
 					</li>
 				</ul>
 				<p>
 					<b>Notice</b>
-					: You'll be able to configure multiple conversation
-					scopes (with different names for sure) using different persistence
-					strategies or without persistence at all.
-				</p>
-				<p>Thats all for Spring,
-					following the JPA specifiacation and the way we configured JPA above, you
-					have to provide a META-INF/persistence.xml too. But that is not related to
-					Apache MyFaces Orchestra.
-				</p>
+					: You will be able to configure multiple conversation
+					scopes (each one of them will need to have a distinct name)
+                    using different persistence strategies or without persistence at all.
+				</p>
+				<p>That's all for Spring now -
+					according to the JPA specification and your JPA implementation, you will also
+					have to provide a META-INF/persistence.xml too. Please check your JPA provider
+                    documentation on how to do this.
+                </p>
 			</subsection>
 			<subsection
-				name="JSF configuration">Next you have to add two things to your web.xml
+				name="JSF configuration">Next you have to add some entries to your web.xml
 				configuration. They are:
 				<ul>
-					<li>The Spring listeners</li>
+					<li>the Spring listeners</li>
 
-					<li>The Apache MyFaces Orchestra Filter</li>
+					<li>the Apache MyFaces Orchestra Filter</li>
 
-					<li>The Apache MyFaces Orchestra RequestParameterServletFilter</li>
+					<li>the Apache MyFaces Orchestra RequestParameterServletFilter</li>
 				</ul>
-				<p>So this looks like:</p>
+				<p>In the end, the configuration will look like this:</p>
 				<pre>
 &lt;listener&gt;
 	&lt;listener-class&gt;org.springframework.web.context.ContextLoaderListener&lt;/listener-class&gt;
@@ -238,19 +240,20 @@
 					<b>Notice:</b> Replace the <code>*.faces</code> url-pattern
by the one used by your application. 
 				</p>
 				<p>
-					The OrchestraFilter ensures that any resource used e.g. by the orm mapper will be freed.
+					The OrchestraFilter ensures that any resources in use by the underlying framework
+                    (for example those of the ORM mapper in use) will be freed.
 				</p>
 				<p>The RequestParameterServletFilter is
 					responsible to ensure the addition of a conversation related parameter to
-					the url. It does this by wrapping the ServletResponse and override the
+					the url. It does this by wrapping the ServletResponse and overriding the
 					encodeURL methods.
 				</p>
 			</subsection>
-			<subsection name="Conclusion">Thats all
+			<subsection name="Conclusion">That's all
 				for the basic configuration of Apache MyFaces Orchestra, now you should have
 				a working conversation scope. In fact there is nothing special in creating
-				the database access objects (dao) or your business objects (bo). Also your
-				JSF page backing bean will look the same, just that you put it into the
+				the database access objects (DAO) or your business objects (BO). Your
+				JSF page backing bean will also look the same - however, you configure them in Spring
and put them into the
 				conversation scope now.
 			</subsection>
 



Mime
View raw message