[overlord-commits] Overlord SVN: r613 - in cdl/trunk/docs/docbook: samplesguide/src/main/module and 1 other directory.

Author: objectiser Date: 2009-04-30 15:30:05 -0400 (Thu, 30 Apr 2009) New Revision: 613 Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml Log: Sort out minor documentation issues Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml =================================================================== --- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2009-04-30 16:45:30 UTC (rev 612) +++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2009-04-30 19:30:05 UTC (rev 613) @@ -70,8 +70,10 @@ <listitem> Install pi4soa <para> - Unpack the pi4soa pre-packaged Eclipse version into a location alongside the JBossAS installation, or install the relevant plugins (as described on the pi4soa wiki) into an existing Eclipse environment. - </para> + Unpack the pi4soa pre-packaged Eclipse version into a location alongside the JBossAS installation. Once unpacked, start the Eclipse environment and update the plugins using the pi4soa update site (http://pi4soa.sourceforge.net/updates) to obtain the most recent version of the plugins. Alternatively, if you wish to use an existing Eclipse environment, instead of the pre-packaged pi4soa Eclipse version, then simply use the update site from your preferred Eclipse environment. + </para> + <para> +NOTE: When doing the plugin update, if it complains about unresolved dependencies, then the key components to install/update are the core feature (in the modeller category) and the technology preview feature (in the incubator category). <para> If just the service validation capabilities are being used, then no further configuration of the Eclipse environment is necessary. However if the conversational ESB actions, with conformance checking against a Choreography Description, will be used, then the following additional steps will be required: Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml =================================================================== --- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2009-04-30 16:45:30 UTC (rev 612) +++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2009-04-30 19:30:05 UTC (rev 613) @@ -234,23 +234,29 @@ If the Credit Agency returns a failed message, then the Store will send a 'BuyFailed' to user. </listitem> </itemizedlist> - + + <para> +There are two alternate implementations of the services involved in the purchasing example, demonstrating both the stateful and stateless "conversation aware" ESB actions. The <filename>$Overlord/samples</filename> contains a sub-folder for each variation. + </para> <para> To run the <emphasis>purchasing</emphasis> example, firstly ensure that the JBoss Application Server has been fully configured as described in the <emphasis>Installation</emphasis> chapter, and then do the following: </para> <orderedlist> <listitem> -In a command window, go to the <filename>$Overlord/samples/purchasing/store</filename> folder and execute <emphasis role="bold">ant deploy</emphasis> +In a command window, go to the <filename>$Overlord/samples/stateful/purchasing/store</filename> (or <filename>$Overlord/samples/stateless/purchasing/store</filename> if using the stateless approach) folder and execute <emphasis role="bold">ant deploy</emphasis> </listitem> <listitem> -In a command window, go to the <filename>$Overlord/samples/common/creditAgency</filename> folder and execute <emphasis role="bold">ant deploy</emphasis> +In a command window, go to the <filename>$Overlord/samples/common/creditAgency</filename> (or <filename>$Overlord/samples/stateless/common/creditAgency</filename> if using the stateless approach) folder and execute <emphasis role="bold">ant deploy</emphasis> </listitem> <listitem> -In a command window, go to the <filename>$Overlord/samples/client</filename> folder and execute <emphasis role="bold">ant runPurchasingClient</emphasis>, which will send a 'BuyRequest' message to the <emphasis>Store</emphasis>, which will then perform the credit check before returning a response to the client. +In a command window, go to the <filename>$Overlord/samples/client</filename> folder and execute <emphasis role="bold">ant runPurchasingClient</emphasis> (or <emphasis role="bold">ant runStatelessPurchasingClient</emphasis> if using the stateless services), which will send a 'BuyRequest' message to the <emphasis>Store</emphasis>, which will then perform the credit check before returning a response to the client. </listitem> </orderedlist> - + + <para> +NOTE: If you plan to try both the stateful and stateless variations of the service implementation, then please ensure you undeploy the first variation before deploying the second, as they share a common service category/name, used to locate the service by the test client. + </para> </section> </section> Modified: cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml =================================================================== --- cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml 2009-04-30 16:45:30 UTC (rev 612) +++ cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml 2009-04-30 19:30:05 UTC (rev 613) @@ -8,10 +8,10 @@ There are two examples to demonstrate the conversation aware ESB actions(for both stateful and stateless), and the conformance checking against a choreography. </para> <para> -These are <filename>purchasing</filename>, a simple customer/supplier example with two associated Eclipse projects (<filename>purchasing-store</filename> and <filename>purchasing-models</filename>), and <filename>brokerage</filename> which extends the purchasing example through the introduction of a broker that mediates between potentially multiple suppliers to find the best deal, defined within three Eclipse projects (<filename>brokerage-broker</filename>, <filename>brokerage-supplier</filename> and <filename>brokerage-models</filename>). +These are <filename>purchasing</filename>, a simple customer/supplier example with two associated Eclipse projects (<filename>purchasing-store-stateful/less</filename> and <filename>purchasing-models</filename>), and <filename>brokerage</filename> which extends the purchasing example through the introduction of a broker that mediates between potentially multiple suppliers to find the best deal, defined within three Eclipse projects (<filename>brokerage-broker-stateful/less</filename>, <filename>brokerage-supplier-stateful/less</filename> and <filename>brokerage-models</filename>). </para> <para> -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. +These examples make use of a common <emphasis>Credit Agency</emphasis> service, defined within the <filename>common-creditAgency-stateful/less</filename> Eclipse project, and are executed through the use of client applications defined in the <filename>${OverlordCDL}/samples/client</filename> folder. </para> <warning> @@ -50,7 +50,7 @@ </para> <orderedlist> <listitem> -Double click on <filename>purchasing-store/src/main/resources/META-INF/jboss-esb.xml</filename> +Double click on <filename>purchasing-store[-stateful/less]/src/main/resources/META-INF/jboss-esb.xml</filename> </listitem> <listitem> Scroll down to the second action, within the first service. This represents a <emphasis>ReceiveMessageAction</emphasis> and has a property defining the message type to be received. @@ -74,7 +74,7 @@ <title>Running the Example</title> <para> This example has two versions, stateful and stateless. in the sample folder, you will find the samples were grouped in stateful and stateless folder. - One is the sateful purchasing example (this is the example that we had since M1 release),the other is stateless purchasing example that is introduced in the M2 release. + One is the stateful purchasing example (this is the example that we had since M1 release),the other is stateless purchasing example that is introduced in the M2 release. </para> <orderedlist> <listitem> @@ -149,7 +149,7 @@ </para> <orderedlist> <listitem> -Double click on <filename>brokerage-broker/src/main/resources/META-INF/jboss-esb.xml</filename> +Double click on <filename>brokerage-broker[-stateful/less]/src/main/resources/META-INF/jboss-esb.xml</filename> </listitem> <listitem> Scroll down to the second action, within the first service. This represents a <emphasis>ReceiveMessageAction</emphasis> and has a property defining the message type to be received. @@ -175,10 +175,10 @@ <orderedlist> <listitem> First step is to install the ESB services (Presumely the JBoss ESB server started already) - In a command window, Go to the <filename>$Overlord/samples/stateful</filename> folder (or <filename>$Overlord/sample/stateless</filename> in the stateless approach), execute <emphasis role="bold">ant deploy-broker</emphasis> + In a command window, Go to the <filename>$Overlord/samples/stateful</filename> folder (or <filename>$Overlord/samples/stateless</filename> in the stateless approach), execute <emphasis role="bold">ant deploy-broker</emphasis> </listitem> <listitem> - Go to the <filename>$Overlord/samples/client</filename> folder and execute <emphasis role="bold">ant runBrokerageClient</emphasis> (or <emphasis role="bold"> ant runStatelessBrokerageClient</emphasis> in stateless approach.), which will initially send an 'enquiry' message to the Broker, which will communicate with the set of Suppliers to obtain the best quote. The client will then send a 'buy' request, which will result in the Broker performing a credit check before returning a response to the client. + Go to the <filename>$Overlord/samples/client</filename> folder and execute <emphasis role="bold">ant runBrokerageClient</emphasis> (or <emphasis role="bold"> ant runStatelessBrokerageClient</emphasis> in stateless approach), which will initially send an 'enquiry' message to the Broker, which will communicate with the set of Suppliers to obtain the best quote. The client will then send a 'buy' request, which will result in the Broker performing a credit check before returning a response to the client. </listitem> </orderedlist>