[overlord-commits] Overlord SVN: r445 - cdl/trunk/docs/docbook/samplesguide/src/main/module.

[overlord-commits at lists.jboss.org]

Author: jeff.yuchang
Date: 2008-11-15 08:08:31 -0500 (Sat, 15 Nov 2008)
New Revision: 445

Modified:
   cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml
   cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml
Log:
* Add the hot-deploy issue warnning in the samples guide.
* Restructure the 'ant deploy-error-client' explanation. 


Modified: cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml
===================================================================
--- cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml	2008-11-14 15:59:58 UTC (rev 444)
+++ cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml	2008-11-15 13:08:31 UTC (rev 445)
@@ -11,6 +11,11 @@
 These examples make use of a common <emphasis>Credit Agency</emphasis> service, defined within the <filename>common-creditAgency</filename> Eclipse project, and are executed through the use of client applications defined in the <filename>${OverlordCDL}/samples/client</filename> folder.
   </para>
 
+   <warning>
+	   At the moment, the conversation aware ESB runtime doesn't support the hot-deploy. That means if you update the business pojo class, such as <emphasis role="bold">$creditAgency/src/main/com/acme/services/creditAgency/CreditAgencyPurchase.java</emphasis> file,
+	   You need to re-deploy it, and then <emphasis role="bold">restart the server </emphasis> to cause it to take effect. This issue has been tracked under <ulink url="https://jira.jboss.org/jira/browse/SOAG-72">https://jira.jboss.org/jira/browse/SOAG-72</ulink>. Will be fixed in the next release.
+   </warning>	
+	
   <section>
 	<title>Purchasing Example</title>
 

Modified: cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml
===================================================================
--- cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml	2008-11-14 15:59:58 UTC (rev 444)
+++ cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml	2008-11-15 13:08:31 UTC (rev 445)
@@ -92,34 +92,39 @@
 	</para>
     <orderedlist>
 	<listitem>
-Edit the LoanBroker.java in the <filename>$Overlord/samples/trailblazer/client/src/org/jboss/soa/esb/samples/trailblazer/loanbroker</filename> folder
+		Run the ant task <emphasis role="bold">ant deploy-error-client</emphasis> to redeploy the trailblaizer example.
+	</listitem>	
+	<listitem>
+		Run the commands from step 6 above.
 	</listitem>
-	<listitem>
-Find the following code within the <emphasis>processLoanRequest</emphasis> method, and change the 4 to a 7
-
+	</orderedlist>
+	<para>
+		The above steps show how changing the service implementation without updating a choreography can result in behavioural validation errors being detected. 	
+	</para>
+	<tip>
+	   <title>What is changed when we run ant deploy-error-client</title>
+		<para>
+			Compared to command of <emphasis role="bold">ant deploy</emphasis>, basically, we have just updated the following code in
+			<emphasis role="bold">$Overlord/samples/trailblazer/client/src/org/jboss/soa/esb/samples/trailblazer/loanbroker/LoanBroker.java</emphasis> file.
+		</para>
+		<para>
+		In the following code within the <emphasis role="bold">processLoanRequest</emphasis> method, we've changed the "4" to "7"
+		
 <programlisting>
-        //step 2 - check if score is acceptable
-        
+        //step 2 - check if score is acceptable        
         if (score >= 4) {
 </programlisting>
-	</listitem>
-	<listitem>
-Re-deploy the trailblazer example (step 7 above)
-	</listitem>
-	<listitem>
-Issue further loan requests, remembering to change the quote reference each time, until a Credit Check result of between 4 and 6 inclusive occurs, which will result in an out of sequence message being reported (in red) to the Choreography Monitor
-
-<note><para>
-It is currently a requirement that the choreography used within the Choreography Monitor is the same as the description used to locally monitor the services (i.e. within the overlord-cdl-validator.esb/models directory).
-</para></note>
-	</listitem>
-   </orderedlist>
-
+		</para>
+	</tip>  
+	
 	<para>
-	</para>
+	Issue further loan requests, remembering to change the quote reference each time, until a Credit Check result of between 4 and 6 inclusive occurs, which will result in an out of sequence message being reported (in red) to the Choreography Monitor
 
-	<para>
-The above steps show how changing the service implementation without updating a choreography can result in behavioural validation errors being detected. The other way to demonstrate the effect of this change is to simply run the ant task: <emphasis role="bold">ant deploy-error-client</emphasis>, from the <filename>$Overlord/samples/trailblazer</filename> folder, which achieves the same results.
+	<note>
+		<para>
+		It is currently a requirement that the choreography used within the Choreography Monitor is the same as the description used to locally monitor the services (i.e. within the overlord-cdl-validator.esb/models directory).
+		</para>
+	</note>	
 	</para>
 
   </section>