Overlord SVN: r437 - in cdl/trunk/samples/jbossesb/trailblazer: client and 1 other directory.
by overlord-commits＠lists.jboss.org
Author: jeff.yuchang
Date: 2008-11-12 13:12:11 -0500 (Wed, 12 Nov 2008)
New Revision: 437
Added:
cdl/trunk/samples/jbossesb/trailblazer/client/java-files/
Modified:
cdl/trunk/samples/jbossesb/trailblazer/build.xml
Log:
* Add another ant target 'ant deploy-error-client'. Might need to find a better name though.
Modified: cdl/trunk/samples/jbossesb/trailblazer/build.xml
===================================================================
--- cdl/trunk/samples/jbossesb/trailblazer/build.xml 2008-11-12 15:57:50 UTC (rev 436)
+++ cdl/trunk/samples/jbossesb/trailblazer/build.xml 2008-11-12 18:12:11 UTC (rev 437)
@@ -160,7 +160,6 @@
<target name="client.compile"
depends="trailblazer.prepare"
description="Compiling Trailblazer client classes">
-
<javac destdir="${esb.samples.trailblazer.client.classes.dir}"
classpathref="esb.samples.trailblazer.esb.classpath.client" debug="true">
<src path="${esb.samples.trailblazer.client.src.dir}"/>
@@ -216,15 +215,25 @@
</fileset>
</war>
</target>
-
+
+ <target name="deploy">
+ <copy file="${basedir}/client/java-files/SuccessfulLoanBroker.java" tofile="${basedir}/client/src/org/jboss/soa/esb/samples/trailblazer/loanbroker/LoanBroker.java" overwrite="true"/>
+ <antcall target="common-deploy" />
+ </target>
+
+ <target name="deploy-error-client">
+ <echo message="update the error client file" />
+ <copy file="${basedir}/client/java-files/FailedLoanBroker.java" tofile="${basedir}/client/src/org/jboss/soa/esb/samples/trailblazer/loanbroker/LoanBroker.java" overwrite="true"/>
+ <antcall target="common-deploy" />
+ </target>
- <target name="deploy" depends="jar, war">
+ <target name="common-deploy" depends="jar, war">
<echo message="Deploying Trailblazer EAR and WAR files to target server '${target-server}'."/>
<copy todir="${target-server}/deploy">
<fileset dir="${esb.dest}/dist/" includes="trailblazer.esb" />
<fileset dir="${esb.samples.trailblazer.client.dest}/dist/" includes="trailblazer.war" />
</copy>
- </target>
+ </target>
<target name="undeploy">
<delete file="${target-server}/deploy/trailblazer.esb" />
15 years, 5 months
- 1
- 0
Overlord SVN: r436 - in cdl/trunk/docs/docbook/gettingstartedguide/src/main: module and 1 other directory.
by overlord-commits＠lists.jboss.org
Author: objectiser
Date: 2008-11-12 10:57:50 -0500 (Wed, 12 Nov 2008)
New Revision: 436
Added:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ChoreoMonReady.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ConformanceCheckError.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ConformanceCheckErrorMessage.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ConformanceCheckErrorMessageMenu.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateValidatorDialog.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateValidatorMenu.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/MonitorMenu.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/QuickFixDialog.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ShowReferencedDescription.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/TrailblazerWebPage.jpg
Modified:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml
Log:
Finished SOA Governance with CDL section of getting started guide.
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ChoreoMonReady.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ChoreoMonReady.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ConformanceCheckError.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ConformanceCheckError.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ConformanceCheckErrorMessage.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ConformanceCheckErrorMessage.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ConformanceCheckErrorMessageMenu.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ConformanceCheckErrorMessageMenu.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateValidatorDialog.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateValidatorDialog.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateValidatorMenu.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateValidatorMenu.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/MonitorMenu.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/MonitorMenu.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/QuickFixDialog.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/QuickFixDialog.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ShowReferencedDescription.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ShowReferencedDescription.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/TrailblazerWebPage.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/TrailblazerWebPage.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2008-11-12 10:57:21 UTC (rev 435)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2008-11-12 15:57:50 UTC (rev 436)
@@ -127,25 +127,265 @@
</imageobject>
<para>
-The generated project includes the ESB configuration file (in the <filename>conf</filename> folder) and the relevant Java classes in the <filename>src/java</filename> folder. The contents of this project represents a template of the service. Before it can be executed, the ESB configuration file will need to be enhanced to include internal implementation details for the service. The contents of this generated project should be compared to the completed version in the <filename>purchasing-store</filename> project.
+The generated project includes the ESB configuration file (in the <filename>src/conf</filename> folder) and the relevant Java classes in the <filename>src/java</filename> folder. The contents of this project represents a template of the service. Before it can be executed, the ESB configuration file will need to be enhanced to include internal implementation details for the service. The contents of this generated project should be compared to the completed version in the <filename>purchasing-store</filename> project.
</para>
+
+ <note>
+ <para>
+When the project is generated, if errors are reported against the <filename>jboss-esb.xml</filename>, then simply double-click on the error to launch the ESB configuration file. Then make a minor change, such as adding a new line and then removing it, and save the file again (to force re-validation). This should cause the errors to be cleared. This occurs because the Eclipse tasks that validate the <filename>jboss-esb.xml</filename> file and compiling the new Java classes in the project sometimes gets confused, causing the classes not to be present when the validation rules attempt to access them. This issue is being investigated.
+ </para>
+ </note>
</section>
<section>
<title>Conformance Checking "Conversation Aware" ESB Services</title>
+ <para>
+To demonstrate the conformance checking mechanism, where the behaviour of the ESB service is verifed against its responsiblities as defined within the choreography description, open the <filename>src/conf/jboss-esb.xml</filename> in the <filename>PurchaseGoodsProcess-Store</filename> generated in the previous sub-section.
+ </para>
+
+ <para>
+When the ESB configuration has been loaded into an editor, locate the first <emphasis>ReceiveMessageAction</emphasis> ESB action, which should have a property called <emphasis>messageType</emphasis> with a value of <emphasis>BuyRequest</emphasis>. To cause a conformance checking error, simply append an 'X' to the end of the message type value, as shown in the following screenshot:
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/ConformanceCheckError.jpg" align="center" width="4in" />
+ </imageobject>
+
+ <para>
+This results in an error message being reported:
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/ConformanceCheckErrorMessage.jpg" align="center" width="4in" />
+ </imageobject>
+
+ <para>
+To fix conformance issues, some of the error messages will provide <emphasis>Quick Fix</emphasis> solutions. These can be access using the popup menu associated with the error message:
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/ConformanceCheckErrorMessageMenu.jpg" align="center" width="4in" />
+ </imageobject>
+
+ <para>
+This will display the <emphasis>Quick Fix</emphasis> dialog listing the available resolutions.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/QuickFixDialog.jpg" align="center" width="4in" />
+ </imageobject>
+
+ <para>
+If the <emphasis>Show Referenced Description</emphasis> resolution is selected, then it will cause the choreography description to be launched and the specific interaction to be focused.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/ShowReferencedDescription.jpg" align="center" width="4in" />
+ </imageobject>
+
+ <para>
+If the <emphasis>Update from Referenced Description</emphasis> is selected, then the <filename>jboss-esb.xml</filename> will be automatically updated to remove the appended 'X' from the message type.
+ </para>
+
</section>
<section>
<title>Running "Conversation Aware" ESB Services</title>
+ <para>
+The purchasing example describes the interactions between a Buyer, Store and Credit Agency. The flow for this example would be:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+Buyer send a 'buy' request to Store
+ </listitem>
+ <listitem>
+Store send a 'credit check' request to the Credit Agency.
+ </listitem>
+ <listitem>
+If the Credit Agency returns a successful message, then the Store will send a 'BuyConfirmed' to user.
+ </listitem>
+ <listitem>
+If the Credit Agency returns a failed message, then the Store will send a 'BuyFailed' to user.
+ </listitem>
+ </itemizedlist>
+
+ <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>
+ </listitem>
+ <listitem>
+In a command window, go to the <filename>$Overlord/samples/common/creditAgency</filename> 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.
+ </listitem>
+ </orderedlist>
+
</section>
+ <section>
+ <title>Summary</title>
+
+ <para>
+This section has provided a brief introduction to the design-time SOA governance features provided within the Overlord CDL distribution.
+ </para>
+
+ <para>
+The aim of these capabilities is to enable verification of an implementation, defined using <emphasis>conversation aware</emphasis> ESB actions in this example, against a choreography, which in turn has been verified against business requirements defined using scenarios. Therefore this helps to ensure that the implemented system meets the original business requirements.
+ </para>
+
+ <para>
+Being able to statically check that the implementation should send or receive messages in the correct order is important, as it will reduce the amount of testing required to ensure the service behaves correctly. However it does not enable the internal implementation details to be verified, which may result in invalid decisions being made at runtime, resulting in unexpected paths being taken. Therefore, to ensure this situation does not occur, we also need runtime governance, which is discussed in the following section.
+ </para>
+
+ </section>
+
</section>
<section>
<title>Runtime Governance using Conversation Validation</title>
+ <para>
+Once services have been deployed, as mentioned in the previous section, we still need to be able to verify that the services continue to conform to the choreography description. The <emphasis>Conversation Validation</emphasis> capability within the Overlord CDL distribution can be used to validate the behaviour of each service.
+ </para>
+
+ <para>
+In this section, we will use the Trailblazer example found in the <filename>$Overlord/samples/trailblazer</filename> folder and the <filename>trailblazer-models</filename> Eclipse project.
+ </para>
+
+ <section>
+ <title>Service Validator Configuration</title>
+
+ <para>
+The service validator configuration for a choreography can be created using the <emphasis>Overlord->JBossESB->Generate Validator</emphasis> menu item on the popup menu associated with the <filename>TrailBlazer.cdm</filename> file.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/GenerateValidatorMenu.jpg" align="center" width="3in" />
+ </imageobject>
+
+ <para>
+This results in a dialog being displayed, requesting the path to the file to be generated. The name of the file must be <filename>validator-config.xml</filename>, otherwise the 'Ok' button will not be enabled.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/GenerateValidatorDialog.jpg" align="center" width="4in" />
+ </imageobject>
+
+ <para>
+The information contained within the generated <filename>validator-config.xml</filename> can be merged as appropriate with the file contained within the <filename>$JBossAS/server/default/deploy/overlord-cdl-validator.esb</filename> folder in the JBossAS environment. The validator configuration for the <emphasis>trailblazer</emphasis> example has been preconfigured to be deployed as part of the installation procedure.
+ </para>
+
+ <note>
+ <para>
+If the <filename>validator-config.xml</filename> within the JBossAS environment is modified, then the server needs to be restarted to cause the configuration to take effect.
+ </para>
+ </note>
+
+ </section>
+
+ <section>
+ <title>Deploy the TrailBlazer Example</title>
+
+ <para>
+The first step to deploying the Trailblazer example is to configure the JBossAS environment:
+ </para>
+
+ <orderedlist>
+ <listitem>
+Update the <filename>$JBossAS/server/default/deploy/jbossesb.sar/jbossesb-properties.xml</filename> file, in the section entitled "transports" and specify all of the SMTP mail server settings for your environment.
+ </listitem>
+ <listitem>
+Update the <filename>trailblazer/trailblazer.properties</filename>
+ <para>
+Update the <property>file.bank.monitored.directory</property> and <property>file.output.directory</property> properties. These are folders used by the File Based Bank, and are set to <filename>/tmp/input</filename> and <filename>/tmp/output</filename> by default.
+ </para>
+ </listitem>
+ <listitem>
+Update the <filename>trailblazer/esb/conf/jboss-esb.xml</filename>
+ <para>
+There is a <emphasis>fs-provider</emphasis> block, update the <property>directory</property> attribute value to be the same as the <property>file.output.directory</property> value in <filename>trailblazer.properties</filename> file.
+ </para>
+ </listitem>
+ <listitem>
+Start the JBossAS server
+ </listitem>
+ </orderedlist>
+
+ <para>
+One the server has been started, the next step is to deploy the relevant components into the JBossAS environment. This is achieved by:
+ </para>
+
+ <orderedlist>
+ <listitem>
+From the <filename>trailblazer</filename> folder, execute the command to start the ESB: <emphasis role="bold">ant deploy</emphasis>
+ <para>
+this should deploy the ESB and WAR files to your JBoss AS <filename>server/default</filename>.
+ </para>
+ </listitem>
+ <listitem>
+From the <filename>trailblazer/banks</filename> folder, execute the command to start the JMS Bank service: <emphasis role="bold">ant runJMSBank</emphasis>.
+ </listitem>
+ <listitem>
+From the <filename>trailblazer/banks</filename> folder, execute the command to start the JMS Bank service: <emphasis role="bold">ant runFileBank</emphasis>.
+ </listitem>
+ </orderedlist>
+
+ </section>
+
+ <section>
+ <title>Starting the pi4soa Monitor</title>
+
+ <para>
+The pi4soa Monitor is used to observe a correlated view of the executing business transactions. Each service validator can be configured to report activites (i.e. sent and received messages) that it validates, to enable the correlator to reconstitute a global interpretation of each transaction.
+ </para>
+
+ <para>
+This correlated view of each transaction can be used to understand where each transaction is within the process. It can also be used to report <emphasis>out of sequence</emphasis>, <emphasis>unexpected messages</emphasis> and more general errors in the context of the business process.
+ </para>
+
+ <para>
+A simple monitoring tool is currently provided with the pi4soa tools, to enable the correlated global view of the transactions to be observed. Once the Trailblazer example has been deployed to the JBossAS environment, and the server is running, then the monitoring tool can be launched from the Eclipse environment by selecting the <emphasis>Choreography->Monitor</emphasis> menu item from the popup menu associated with the <filename>TrailBlazer.cdm</filename> file.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/MonitorMenu.jpg" align="center" width="2in" />
+ </imageobject>
+
+ <para>
+Wait for the monitor window to start, and indicate that the choreography is being monitored, shown in the status line at the bottom of the window.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/ChoreoMonReady.jpg" align="center" width="4in" />
+ </imageobject>
+
+ </section>
+
+ <section>
+ <title>Running the Example</title>
+
+ <para>
+To run the example, you need to start a browser and select the URL <ulink url="http://localhost:8080/trailblazer">localhost:8080/trailblazer</ulink>. This will show the following page, if the server has been configured correctly and the TrailBlazer example deployed:
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/TrailblazerWebPage.jpg" align="center" width="4in" />
+ </imageobject>
+
+ <para>
+Now you can submit quotes, You will see either a loan request rejected (single email) because the score is less than 4, or two emails (one from JMS bank and one from FileBased bank) with valid quotes. When entering subsequent quotes, make sure that the quote reference is updated, so that each session has a unique id.
+ </para>
+
+ </section>
+
</section>
</chapter>
15 years, 5 months
- 1
- 0
Overlord SVN: r435 - in cdl/trunk/docs/docbook/gettingstartedguide/src/main: module and 1 other directory.
by overlord-commits＠lists.jboss.org
Author: objectiser
Date: 2008-11-12 05:57:21 -0500 (Wed, 12 Nov 2008)
New Revision: 435
Added:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateESBServicesDialog.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateESBServicesMenu.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateESBServicesNav.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/InvalidPurchasePostTest.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/PurchaseGoods.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/SuccessfulPurchasePostTest.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/SuccessfulPurchasePreTest.jpg
Modified:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml
Log:
Intermediate save of new chapter 2 for Getting Started Guide with images.
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateESBServicesDialog.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateESBServicesDialog.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateESBServicesMenu.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateESBServicesMenu.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateESBServicesNav.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/GenerateESBServicesNav.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/InvalidPurchasePostTest.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/InvalidPurchasePostTest.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/PurchaseGoods.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/PurchaseGoods.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/SuccessfulPurchasePostTest.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/SuccessfulPurchasePostTest.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/SuccessfulPurchasePreTest.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/SuccessfulPurchasePreTest.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2008-11-11 15:25:46 UTC (rev 434)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2008-11-12 10:57:21 UTC (rev 435)
@@ -6,17 +6,145 @@
I wasn't expecting Chapter 2 until much later. I thought that after installation we'd take people through a worked example (glossing over the concepts, but showing people what can be accomplished), but Chapter 2 dives into terms and concepts. I suppose what I was expecting was something like "make sure your Eclipse workspace is set to blah" and blah is a pre-configured workspace that we've set up with a number of different out-of-the-box examples. Then we'd go quickly through them in Chapter 2 before going into more detail about what's going on in subsequent chapters. That way we almost convince people in Chapter 2 that it's worth their while continuing on with the rest of the document. I know that Steve used to do something like this when demo-ing the original CDL tooling, so hopefully it's not too much effort to try to put this in?
+ <para>
+The Choreography Description Language (CDL) provides a means of describing a process, that executes across a distributed set of services, from a global (or service independent) perspective.
+ </para>
-Explain about testable architecture, managing the lifecycle - possibly a cut down version of best practice guide, showing where the conformance checking, generation and monitoring fit in.
+ <para>
+SOA Governance, using CDL, is about ensuring a process is correctly implemented (as part of design-time governance), and executes as expected (part of runtime governance).
+ </para>
+ <para>
+In this chapter we will take you through a worked example associated with each of these aspects.
+ </para>
+ <note>
+ <para>
+Before proceeding, please make sure that the Overlord CDL distribution has been correctly installed and that the samples have been imported into the Eclipse environment.
+ </para>
+ </note>
<section>
- <title>Conversation Validation</title>
+ <title>Design Time Governance using "Conversation Aware" ESB Actions</title>
+ <section>
+ <title>Creating a Choreography</title>
+
+ <para>
+When designing a system, it is necessary to capture requirements. Various approaches can be used for this, but currently there are no mechanisms that enable the requirements to be documented in such a way to enable an implementation to be validated back against the requirements.
+ </para>
+
+ <para>
+The pi4soa tools provide a means of describing requirements, representing specific use cases for the interactions between a set of cooperating services, using scenarios - which can be considered similar to UML sequence diagrams that have been enhanced to include example messages.
+ </para>
+
+ <para>
+In the <filename>purchasing-models</filename> Eclipse project, the <filename>SuccessfulPurchase.scn</filename> scenario looks like this:
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/SuccessfulPurchasePreTest.jpg" align="center" width="5in" />
+ </imageobject>
+
+ <para>
+The next step in the development process is to specific a Choreography Description to implement the requirements described within the set of scenarios. The choreography for the Purchasing example can be found in <filename>purchasing-models/PurchaseGoods.cdm</filename>. When the choreography editor has been launched, by double-clicking on this file within the Eclipse environment, then navigate to the <emphasis>Choreography Flows</emphasis> tab to see the definition of the purchasing process:
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/PurchaseGoods.jpg" align="center" width="5in" />
+ </imageobject>
+
+ <para>
+The pi4soa tools can be used to test the scenarios against the choreography description, to ensure that the choreography correctly implements the requirements. To test the <filename>SuccessfulPurchase.scn</filename> scenario against the choreography, launch the scenario editor by double-clicking on the scenario file, and then pressing the green <emphasis>play</emphasis> button in the toolbar. When complete, the scenario should look like the following image, indicating that the scenario completed successfully.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/SuccessfulPurchasePostTest.jpg" align="center" width="5in" />
+ </imageobject>
+
+ <para>
+To view a scenario that demonstrates a test failure, open the <filename>InvalidPurchase.scn</filename> scenario by double-clicking on the file, and then initiate the test using the green <emphasis>play</emphasis> button in the toolbar. When complete, the scenario should look like the following image.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/InvalidPurchasePostTest.jpg" align="center" width="5in" />
+ </imageobject>
+
+ <para>
+You will notice that the <emphasis>Store</emphasis> participant has a red 'send' node, indicating that this action was not expected behaviour when compared with the choreography description. The reason this is considered an error, is that the <emphasis>Store</emphasis> participant should only send a <emphasis>BuyFailed</emphasis> message following an invalid credit check.
+ </para>
+
+ <para>
+When an error is detected in a scenario, the choreography designer can then determine whether the scenario is wrong (i.e. it does not correctly describe a business requirement), or whether the choreography is wrong and needs to be updated to accomodate the scenario.
+ </para>
+
+ <para>
+Once the choreography description has been successfully tested against the scenarios, and therefore is shown to meet the business requirements, the next step is to design and implement each service involved in the choreography. The pi4soa tools provide the means to export BPMN, UML or HTML documentation to aid the implementation phase. However there is special support for a concept called "Conversation Aware" ESB Actions.
+ </para>
+ </section>
+
+ <section>
+ <title>What are "Conversation Aware" ESB Actions?</title>
+
+ <para>
+<emphasis>Conversation aware</emphasis> ESB actions refer to a set of pre-defined ESB actions that enable the structure (or behaviour) of a service to be inferred.
+ </para>
+
+ <para>
+For example, there are actions that explicitly define the sending and receiving of messages. These actions define a property that declares the type of the message being sent or received. Other actions describe grouping constructs such as if/else, parallel and while loop.
+ </para>
+
+ <para>
+The benefit of making these concepts explicit within the ESB service configuration, is that it makes it possible to check the implementation correctly matches the expected behaviour as defined within the choreography. This will be demonstrated in the following sub-section discussing conformance checking.
+ </para>
+
+ </section>
+
+ <section>
+ <title>Generating an ESB Service using "Conversation Aware" ESB Actions</title>
+
+ <para>
+Once we have a choreography description, it is possible to generate an ESB Service (with <emphasis>conversation aware</emphasis> ESB actions), for each of the participants defined within the choreography. To try this out, select the <emphasis>Overlord->JBossESB->Generate ESB Services</emphasis> menu item from the popup menu associated with the <filename>PurchaseGoods.cdm</filename>.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/GenerateESBServicesMenu.jpg" align="center" width="3in" />
+ </imageobject>
+
+ <para>
+This will display a dialog listing the possible services that can be generated from this choreography, with a proposed Eclipse project name.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/GenerateESBServicesDialog.jpg" align="center" width="3in" />
+ </imageobject>
+
+ <para>
+To test out this feature, uncheck the <emphasis>Buyer</emphasis> and <emphasis>CreditAgency</emphasis> participants, leave the build system as <emphasis>Ant</emphasis> and press the 'Ok' button. This will create a single new project for the <emphasis>Store</emphasis> participant.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/GenerateESBServicesNav.jpg" align="center" width="2in" />
+ </imageobject>
+
+ <para>
+The generated project includes the ESB configuration file (in the <filename>conf</filename> folder) and the relevant Java classes in the <filename>src/java</filename> folder. The contents of this project represents a template of the service. Before it can be executed, the ESB configuration file will need to be enhanced to include internal implementation details for the service. The contents of this generated project should be compared to the completed version in the <filename>purchasing-store</filename> project.
+ </para>
+ </section>
+
+ <section>
+ <title>Conformance Checking "Conversation Aware" ESB Services</title>
+
+ </section>
+
+ <section>
+ <title>Running "Conversation Aware" ESB Services</title>
+
+ </section>
+
</section>
<section>
- <title>Conversation Aware ESB</title>
+ <title>Runtime Governance using Conversation Validation</title>
</section>
15 years, 5 months
- 1
- 0
Overlord SVN: r434 - in cdl/trunk/docs/docbook: gettingstartedguide/src/main/images and 2 other directories.
by overlord-commits＠lists.jboss.org
Author: objectiser
Date: 2008-11-11 10:25:46 -0500 (Tue, 11 Nov 2008)
New Revision: 434
Added:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportDialog.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportFileDialog.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportMenu.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportProjectsDialog.jpg
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportedProjects.jpg
Removed:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-aware-esb.xml
cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-validation-with-cdl.xml
cdl/trunk/docs/docbook/samplesguide/src/main/module/template.xml
Modified:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml
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
cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml
cdl/trunk/docs/docbook/samplesguide/src/main/module/overview.xml
Log:
Added more screenshots, also changed to import all projects in one step, as part of the installation procedure.
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportDialog.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportDialog.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportFileDialog.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportFileDialog.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportMenu.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportMenu.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportProjectsDialog.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportProjectsDialog.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportedProjects.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportedProjects.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2008-11-11 12:28:12 UTC (rev 433)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2008-11-11 15:25:46 UTC (rev 434)
@@ -13,7 +13,5 @@
<toc/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/installation.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/soagwithcdl.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/conversation-validation-with-cdl.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/conversation-aware-esb.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/appendix.xml"/>
</book>
Deleted: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-aware-esb.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-aware-esb.xml 2008-11-11 12:28:12 UTC (rev 433)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-aware-esb.xml 2008-11-11 15:25:46 UTC (rev 434)
@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-]>
-<chapter id="conversationawareesb">
- <title>Conversation Aware ESB</title>
-
-</chapter>
-
Deleted: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-validation-with-cdl.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-validation-with-cdl.xml 2008-11-11 12:28:12 UTC (rev 433)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-validation-with-cdl.xml 2008-11-11 15:25:46 UTC (rev 434)
@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-]>
-<chapter id="conversationvalidationwithcdl">
- <title>Conversation Validation with CDL</title>
-
-</chapter>
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2008-11-11 12:28:12 UTC (rev 433)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2008-11-11 15:25:46 UTC (rev 434)
@@ -121,5 +121,57 @@
</orderedlist>
</section>
+
+ <section>
+ <title>Importing Samples into Eclipse</title>
+
+ <para>
+ Once the Overlord CDL distribution has been correctly installed, if you wish to try out any of the examples then
+ the following steps should be followed to import the relevant projects into the previously configured Eclipse
+ environment.
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+Select the 'Import...' menu item, associated with the popup menu on the background of the left panal (Navigator or Package depending on perspective being viewed).
+ </para>
+ <imageobject>
+ <imagedata fileref="images/ImportMenu.jpg" align="center" width="2in" />
+ </imageobject>
+ </listitem>
+ <listitem>
+ <para>
+When the import dialog appears, select the <emphasis>General->ExistingProject from Workspace</emphasis> option and press the 'Next' button.
+ </para>
+ <imageobject>
+ <imagedata fileref="images/ImportDialog.jpg" align="center" width="4in" />
+ </imageobject>
+ </listitem>
+ <listitem>
+ <para>
+Ensuring that the 'Select root directory' radio button is selected, press the 'Browse' button and navigate to the <filename>${OverlordCDL}/samples</filename> folder, then press 'Ok'.
+ </para>
+ <imageobject>
+ <imagedata fileref="images/ImportFileDialog.jpg" align="center" width="3in" />
+ </imageobject>
+ </listitem>
+ <listitem>
+ <para>
+All of the Eclipse projects contained within the <filename>samples</filename> directory structure will be listed. Press the 'Finish' button to import them all.
+ </para>
+ <imageobject>
+ <imagedata fileref="images/ImportProjectsDialog.jpg" align="center" width="4in" />
+ </imageobject>
+ <para>
+ Once imported, the Eclipse navigator will list the sample projects:
+ </para>
+ <imageobject>
+ <imagedata fileref="images/ImportedProjects.jpg" align="center" width="2in" />
+ </imageobject>
+ </listitem>
+ </orderedlist>
+
+ </section>
</chapter>
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2008-11-11 12:28:12 UTC (rev 433)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2008-11-11 15:25:46 UTC (rev 434)
@@ -3,5 +3,21 @@
]>
<chapter id="soagwithcdl">
<title>SOA Governance with CDL </title>
-
+
+I wasn't expecting Chapter 2 until much later. I thought that after installation we'd take people through a worked example (glossing over the concepts, but showing people what can be accomplished), but Chapter 2 dives into terms and concepts. I suppose what I was expecting was something like "make sure your Eclipse workspace is set to blah" and blah is a pre-configured workspace that we've set up with a number of different out-of-the-box examples. Then we'd go quickly through them in Chapter 2 before going into more detail about what's going on in subsequent chapters. That way we almost convince people in Chapter 2 that it's worth their while continuing on with the rest of the document. I know that Steve used to do something like this when demo-ing the original CDL tooling, so hopefully it's not too much effort to try to put this in?
+
+
+Explain about testable architecture, managing the lifecycle - possibly a cut down version of best practice guide, showing where the conformance checking, generation and monitoring fit in.
+
+
+ <section>
+ <title>Conversation Validation</title>
+
+ </section>
+
+ <section>
+ <title>Conversation Aware ESB</title>
+
+ </section>
+
</chapter>
Modified: cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml
===================================================================
--- cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml 2008-11-11 12:28:12 UTC (rev 433)
+++ cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml 2008-11-11 15:25:46 UTC (rev 434)
@@ -5,10 +5,10 @@
<title>CDL Conformance</title>
<para>
-There are two examples to demonstrate the conversation aware ESB actions, and the conformance checking against a choreography. These are <filename>purchasing</filename>, a simple customer/supplier example, 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.
+There are two examples to demonstrate the conversation aware ESB actions, and the conformance checking against a choreography. 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>).
</para>
<para>
-The other relevant folders for these examples are, <filename>common</filename> which contains the service implementation of the 'Credit Agency' which is used by both examples, and <filename>client</filename> which contains client applications to test both examples.
+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>
<section>
@@ -33,28 +33,7 @@
</itemizedlist>
<para>
-To check conformance, we need to import the model and service implementation projects into the Eclipse environment. This is achieved by:
- </para>
- <orderedlist>
- <listitem>
-Select the <emphasis role="bold">'Import...'</emphasis> menu item, associated with the context menu on the background of the left panal (Navigator or Package depending on perspective being viewed). When the import dialog appears, select the <emphasis role="bold">General->ExistingProject</emphasis> from Workspace option and press the <emphasis role="bold">'Next'</emphasis> button.
- </listitem>
- <listitem>
-Ensuring that the 'Select root directory' radio button is selected, press the <emphasis role="bold">'Browse'</emphasis> button and navigate to the <filename>samples/purchasing/models</filename> folder, press 'Ok' and then press 'Finish'.
- </listitem>
- <listitem>
-Then repeat steps (1) and (2) for the following project folders:
- <itemizedlist>
- <listitem>
- <filename>samples/purchasing/store</filename>
- </listitem>
- <listitem>
- <filename>samples/common/creditAgency</filename>
- </listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
- <para>
+To check conformance, we need to refer to the model and service implementation projects in the Eclipse environment.
The <filename>purchasing-models</filename> project contains the CDL used to perform conformance checking on the <filename>src/main/resources/META-INF/jboss-esb.xml</filename> files within the other projects. A full explanation of the conversation aware ESB actions can be found in the <emphasis>Conversational Aware ESB</emphasis> section of the <emphasis>User Guide</emphasis> in the <filename>docs</filename> folder.
</para>
<para>
@@ -155,31 +134,7 @@
</itemizedlist>
<para>
-To check conformance, we need to import the model and service implementation projects into the Eclipse environment. This is achieved by:
- </para>
- <orderedlist>
- <listitem>
-Select the 'Import...' menu item, associated with the context menu on the background of the left panal (Navigator or Package depending on perspective being viewed). When the import dialog appears, select the <emphasis>General->ExistingProject from Workspace</emphasis> option and press the 'Next' button.
- </listitem>
- <listitem>
-Ensuring that the 'Select root directory' radio button is selected, press the 'Browse' button and navigate to the <emphasis>samples/brokerage/models</emphasis> folder, press 'Ok' and then press 'Finish'.
- </listitem>
- <listitem>
-Then repeat steps (1) and (2) for the following project folders:
- <itemizedlist>
- <listitem>
- <filename>samples/brokerage/broker</filename>
- </listitem>
- <listitem>
- <filename>samples/brokerage/supplier</filename>
- </listitem>
- <listitem>
- <filename>samples/common/creditAgency</filename> (if not already imported for the previous example)
- </listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
- <para>
+To check conformance, we need to refer to the model and service implementation projects in the Eclipse environment.
The <filename>brokerage-models</filename> project contains the CDL used to perform conformance checking on the <filename>src/main/resources/META-INF/jboss-esb.xml</filename> files within the other brokerage projects. A full explanation of the conversation aware ESB actions can be found in the <emphasis>Conversational Aware ESB</emphasis> section of the <emphasis>User Guide</emphasis> in the <filename>docs</filename> folder.
</para>
<para>
Modified: cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml
===================================================================
--- cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml 2008-11-11 12:28:12 UTC (rev 433)
+++ cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml 2008-11-11 15:25:46 UTC (rev 434)
@@ -11,24 +11,22 @@
This example can be found in the <filename>trailblazer</filename> folder, which contains an enhanced version of the trailblazer example found in the JBossESB distribution. See the TrailBlazer Guide in the JBossESB distribution (<filename>$JBossESB/docs/samples/TBGuide.pdf</filename>) for more information about the example. The main changes are the introduction of a File Based Bank, and modifications to the message structures to enable a consistent conversation id to be carried with the messages.
</para>
- <orderedlist>
- <listitem>
-Update the <filename>$JBossAS/server/default/deploy/jbossesb.sar/jbossesb-properties.xml</filename> file, in the section entitled "transports" and specify all of the SMTP mail server settings for your environment.
- </listitem>
- <listitem>
-Select the 'Import...' menu item, associated with the popup menu on the background of the left panal (Navigator or Package depending on perspective being viewed). When the import dialog appears, select the <emphasis>General->ExistingProject from Workspace</emphasis> option and press the 'Next' button.
- </listitem>
- <listitem>
-Ensuring that the 'Select root directory' radio button is selected, press the 'Browse' button and navigate to the <filename>samples/trailblazer/models</filename> folder, press 'Ok' and then press 'Finish'.
-
<note>
<para>
-Once the models project has been installed, you can open the choreography for the trailblazer (trailblazer.cdm) and also a scenario representing a valid transaction associated with the choreography (LoanRequest.scn). In the choreography description editor, view the "Choreography Flows" tab to see the structure of the process.
+The choreography description for the Trailblazer example can be found in the <emphasis>trailblazer-models</emphasis> project in the Eclipse environment. If the project has not yet been imported, then please refer to the instructions in the <emphasis>Getting Started Guide</emphasis>.
</para>
<para>
+You can open the choreography for the trailblazer (trailblazer.cdm) and also a scenario representing a valid transaction associated with the choreography (LoanRequest.scn). In the choreography description editor, view the "Choreography Flows" tab to see the structure of the process.
+ </para>
+ <para>
To simulate the scenario against the choreography, to ensure that the choreography correctly caters for the valid business scenario, the user should press the green 'play' button in the toolbar, associated with the Scenario Editor.
</para>
</note>
+
+
+ <orderedlist>
+ <listitem>
+Update the <filename>$JBossAS/server/default/deploy/jbossesb.sar/jbossesb-properties.xml</filename> file, in the section entitled "transports" and specify all of the SMTP mail server settings for your environment.
</listitem>
<listitem>
Update the <filename>trailblazer/trailblazer.properties</filename>
Modified: cdl/trunk/docs/docbook/samplesguide/src/main/module/overview.xml
===================================================================
--- cdl/trunk/docs/docbook/samplesguide/src/main/module/overview.xml 2008-11-11 12:28:12 UTC (rev 433)
+++ cdl/trunk/docs/docbook/samplesguide/src/main/module/overview.xml 2008-11-11 15:25:46 UTC (rev 434)
@@ -23,7 +23,7 @@
<note>
<para>
- Before attempting to install and run these examples, you must follow the instructions in the <emphasis role="bold">"Getting Started" Chapter</emphasis> of the <emphasis role="bold">User Guide</emphasis> regarding installing Overlord CDL into a JBossAS environment.
+ Before attempting to install and run these examples, you must follow the instructions in the <emphasis role="bold">"Installation" Chapter</emphasis> of the <emphasis role="bold">Getting Started Guide</emphasis> regarding installing Overlord CDL into a JBossAS environment, and importing the samples into the Eclipse environment.
</para>
</note>
Deleted: cdl/trunk/docs/docbook/samplesguide/src/main/module/template.xml
===================================================================
--- cdl/trunk/docs/docbook/samplesguide/src/main/module/template.xml 2008-11-11 12:28:12 UTC (rev 433)
+++ cdl/trunk/docs/docbook/samplesguide/src/main/module/template.xml 2008-11-11 15:25:46 UTC (rev 434)
@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-]>
-<chapter id="chapter-id">
- <title>Chapter title</title>
- <para>To be written...</para>
-</chapter>
15 years, 5 months
- 1
- 0
Overlord SVN: r433 - in cdl/trunk/docs/docbook: gettingstartedguide/src/main/module and 3 other directories.
by overlord-commits＠lists.jboss.org
Author: objectiser
Date: 2008-11-11 07:28:12 -0500 (Tue, 11 Nov 2008)
New Revision: 433
Added:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/JavaCompiler1-5Compliant.jpg
cdl/trunk/docs/docbook/samplesguide/src/main/images/ChoreoMonReady.jpg
cdl/trunk/docs/docbook/samplesguide/src/main/images/MonitorMenu.jpg
cdl/trunk/docs/docbook/samplesguide/src/main/images/TrailblazerWebPage.jpg
Removed:
cdl/trunk/docs/docbook/userguide/src/main/module/template.xml
Modified:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml
cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml
cdl/trunk/docs/docbook/userguide/src/main/module/conversation-aware-esb.xml
cdl/trunk/docs/docbook/userguide/src/main/module/conversation-validation-with-cdl.xml
Log:
Added some screenshots.
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/JavaCompiler1-5Compliant.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/JavaCompiler1-5Compliant.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2008-11-11 10:29:23 UTC (rev 432)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2008-11-11 12:28:12 UTC (rev 433)
@@ -82,6 +82,17 @@
Start the Eclipse environment
</listitem>
<listitem>
+ <para>
+ Overload CDL is currently JDK1.5 compliant. Therefore it is necessary to ensure that the Eclipse environment also compiles classes, used by the ESB "conversation aware" actions, as 1.5 complaint. This can be achieved by selecting the <emphasis>Windows->Preferences</emphasis> menu item, and selecting the <emphasis>Java->Compiler</emphasis> node, and setting the compliance level to 1.5, as shown in the following image:
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/JavaCompiler1-5Compliant.jpg" align="center" width="4in" />
+ </imageobject>
+
+
+ </listitem>
+ <listitem>
Select the “Help - > Software Updates...” menu item
</listitem>
<listitem>
Added: cdl/trunk/docs/docbook/samplesguide/src/main/images/ChoreoMonReady.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/samplesguide/src/main/images/ChoreoMonReady.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/samplesguide/src/main/images/MonitorMenu.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/samplesguide/src/main/images/MonitorMenu.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: cdl/trunk/docs/docbook/samplesguide/src/main/images/TrailblazerWebPage.jpg
===================================================================
(Binary files differ)
Property changes on: cdl/trunk/docs/docbook/samplesguide/src/main/images/TrailblazerWebPage.jpg
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml
===================================================================
--- cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml 2008-11-11 10:29:23 UTC (rev 432)
+++ cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml 2008-11-11 12:28:12 UTC (rev 433)
@@ -16,7 +16,7 @@
Update the <filename>$JBossAS/server/default/deploy/jbossesb.sar/jbossesb-properties.xml</filename> file, in the section entitled "transports" and specify all of the SMTP mail server settings for your environment.
</listitem>
<listitem>
-Select the 'Import...' menu item, associated with the context menu on the background of the left panal (Navigator or Package depending on perspective being viewed). When the import dialog appears, select the <emphasis>General->ExistingProject from Workspace</emphasis> option and press the 'Next' button.
+Select the 'Import...' menu item, associated with the popup menu on the background of the left panal (Navigator or Package depending on perspective being viewed). When the import dialog appears, select the <emphasis>General->ExistingProject from Workspace</emphasis> option and press the 'Next' button.
</listitem>
<listitem>
Ensuring that the 'Select root directory' radio button is selected, press the 'Browse' button and navigate to the <filename>samples/trailblazer/models</filename> folder, press 'Ok' and then press 'Finish'.
@@ -58,10 +58,32 @@
From the <filename>trailblazer/banks</filename> folder, execute the command to start the JMS Bank service: <emphasis role="bold">ant runFileBank</emphasis>.
</listitem>
<listitem>
-In the Eclipse environment, select the context menu associated with the <filename>trailblazer.cdm</filename> file, and choose the <emphasis>Choreography->Monitor</emphasis> menu item. Wait for the monitor window to start, and indicate that the choreography is being monitored, shown in the status line at the bottom of the window.
+ <para>
+In the Eclipse environment, select the popup menu associated with the <filename>trailblazer.cdm</filename> file, and choose the <emphasis>Choreography->Monitor</emphasis> menu item.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/MonitorMenu.jpg" align="center" width="2in" />
+ </imageobject>
+
+ <para>
+Wait for the monitor window to start, and indicate that the choreography is being monitored, shown in the status line at the bottom of the window.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/ChoreoMonReady.jpg" align="center" width="4in" />
+ </imageobject>
+
</listitem>
<listitem>
+ <para>
Start a browser and enter the URL: <ulink url="http://localhost:8080/trailblazer">localhost:8080/trailblazer</ulink>.
+ </para>
+
+ <imageobject>
+ <imagedata fileref="images/TrailblazerWebPage.jpg" align="center" width="4in" />
+ </imageobject>
+
</listitem>
<listitem>
Now you can submit quotes, You will see either a loan request rejected (single email) because the score is less than 4, or two emails (one from JMS bank and one from FileBased bank) with valid quotes. When entering subsequent quotes, make sure that the quote reference is updated, so that each session has a unique id.
Modified: cdl/trunk/docs/docbook/userguide/src/main/module/conversation-aware-esb.xml
===================================================================
--- cdl/trunk/docs/docbook/userguide/src/main/module/conversation-aware-esb.xml 2008-11-11 10:29:23 UTC (rev 432)
+++ cdl/trunk/docs/docbook/userguide/src/main/module/conversation-aware-esb.xml 2008-11-11 12:28:12 UTC (rev 433)
@@ -220,7 +220,7 @@
The <emphasis>conversation type</emphasis> is specified in the <emphasis>CreateSessionAction</emphasis> ESB action, described later in this section, and is associated as a semantic annotation against the relevant Participant Type or Participant Instance within the choreography description.
<para>
</para>
-To associate the <emphasis>conversation type</emphasis> with either the Participant Type or Instance, open the choreography description in the <emphasis>pi4soa</emphasis> choreography designer. Then select the "Choreography->Edit Annotations" menu item from the context menu associated with the Participant Type or Instance. In the lefthand panel, select "Add Freeform Annotation" from the context menu, then specify "conversationType" as the annotation type and press 'Ok'. Then select the 'Annotation' tab in the righthand panel, and enter the conversation type, e.g. "overlord.cdl.samples.LoanBroker@Broker". Note the '@' is important, as the following word indicates the 'role' associated with the conversation type which precedes the '@' symbol.
+To associate the <emphasis>conversation type</emphasis> with either the Participant Type or Instance, open the choreography description in the <emphasis>pi4soa</emphasis> choreography designer. Then select the "Choreography->Edit Annotations" menu item from the popup menu associated with the Participant Type or Instance. In the lefthand panel, select "Add Freeform Annotation" from the popup menu, then specify "conversationType" as the annotation type and press 'Ok'. Then select the 'Annotation' tab in the righthand panel, and enter the conversation type, e.g. "overlord.cdl.samples.LoanBroker@Broker". Note the '@' is important, as the following word indicates the 'role' associated with the conversation type which precedes the '@' symbol.
</para>
<imagedata fileref="images/setconversationtype.png" width="4in" />
@@ -805,7 +805,7 @@
<section>
<title>Generating the JBossESB Configuration</title>
<para>
-When the choreography description has been completed, and has no errors, the user should select the "Overlord->JBossESB->Generate ESB Services" menu item from the context menu associated with the choreography description (.cdm) file.
+When the choreography description has been completed, and has no errors, the user should select the "Overlord->JBossESB->Generate ESB Services" menu item from the popup menu associated with the choreography description (.cdm) file.
</para>
<imageobject>
Modified: cdl/trunk/docs/docbook/userguide/src/main/module/conversation-validation-with-cdl.xml
===================================================================
--- cdl/trunk/docs/docbook/userguide/src/main/module/conversation-validation-with-cdl.xml 2008-11-11 10:29:23 UTC (rev 432)
+++ cdl/trunk/docs/docbook/userguide/src/main/module/conversation-validation-with-cdl.xml 2008-11-11 12:28:12 UTC (rev 433)
@@ -148,7 +148,7 @@
<para>
When the annotation editor is displayed for the relevant 'exchange details' component,
the <emphasis>jbossesb</emphasis> annotation should be added. This is achieved by
- selecting the context menu associated with the background of the lefthand panel,
+ selecting the popup menu associated with the background of the lefthand panel,
and selecting the <emphasis>Add Defined Annotation</emphasis> menu item.
</para>
@@ -196,7 +196,7 @@
To generate the validator configuration details from a choreography description
into the format used by the central configuration mechanism (described previously),
select the <emphasis>Overlord->JBossESB->Generate Validator</emphasis> menu item
- associated with the context menu for the choreography description.
+ associated with the popup menu for the choreography description.
</para>
<imageobject>
@@ -271,7 +271,7 @@
The destination defined in this file must match the one configured in the <emphasis>pi4soa.sar/pi4soa.xml</emphasis> file within the server.
</para>
<para>
-The next step is to launch the monitoring tool. This is located on the context menu, for the choreography description (i.e. .cdm) file, by selecting the Choreography->Monitor menu item. Once the tool has been launched, it will load the choreography description, subscribe to the relevant event destination, and then indicate via a message in the bottom status line that it is ready to monitor.
+The next step is to launch the monitoring tool. This is located on the popup menu, for the choreography description (i.e. .cdm) file, by selecting the Choreography->Monitor menu item. Once the tool has been launched, it will load the choreography description, subscribe to the relevant event destination, and then indicate via a message in the bottom status line that it is ready to monitor.
</para>
<imageobject>
Deleted: cdl/trunk/docs/docbook/userguide/src/main/module/template.xml
===================================================================
--- cdl/trunk/docs/docbook/userguide/src/main/module/template.xml 2008-11-11 10:29:23 UTC (rev 432)
+++ cdl/trunk/docs/docbook/userguide/src/main/module/template.xml 2008-11-11 12:28:12 UTC (rev 433)
@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-]>
-<chapter id="chapter-id">
- <title>Chapter title</title>
- <para>To be written...</para>
-</chapter>
15 years, 5 months
- 1
- 0
Overlord SVN: r432 - in cdl/trunk/docs/docbook: userguide/src/main/module and 1 other directory.
by overlord-commits＠lists.jboss.org
Author: objectiser
Date: 2008-11-11 05:29:23 -0500 (Tue, 11 Nov 2008)
New Revision: 432
Modified:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml
cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml
Log:
Moved the summary information back from the Getting Started Guide to the User Guide where it was originally. The information in the Getting Started Guide needs to be elaborated, so this text should still provide a good enough summary for the User Guide.
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2008-11-11 09:36:40 UTC (rev 431)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2008-11-11 10:29:23 UTC (rev 432)
@@ -3,208 +3,5 @@
]>
<chapter id="soagwithcdl">
<title>SOA Governance with CDL </title>
- <section>
- <title>Overview</title>
- <para>
- The CDL component of the Overlord SOA governance project aims to leverage the concept of a choreography (or conversation)
- description to provide design-time and run-time governance of an SOA.
- </para>
- <para>
- A Choreography provides the means to describe the service interactions between multiple parties from a global (or service neutral) perspective.
- This means that it is possible for an organisation to define how an end-to-end business process should function, regardless of whether orchestrated
- or peer-to-peer service collaboration will be used.
- </para>
- <para>
- Although in simple situations, a BPEL process description can provide a description of the interactions between multiple services, this only works where a
- single orchestrating process is in control. The benefit of the choreography description is that it can be used to provide a global view of a process across multiple
- orchestrated service domains.
- </para>
- <para>
- This document will outline how the Choreography Description is being used as part of Project Overlord to provide SOA governance capabilities
- for each phase of the SOA lifecycle.
- </para>
- <para>
- When a validated design has been approved by the users, it can be used to generate an initial skeleton of the implementation for each service.
- The current version of Overlord enables a skeleton implementation to be generated as a JBossESB service configuration file,
- using 'conversation aware' ESB actions. For more information on these, please see the “Conversational ESB User Guide”.
- </para>
- </section>
-
- <section>
- <title>WS-CDL</title>
-
- <para>
-WS-CDL, or Web Service Choreography Description Language, is a candidate recommendation from W3C. Although associated with W3C and Web Services, it is important to begin by stating that the Choreography Description Language (CDL) is <emphasis role="bold">not</emphasis> web service specific.
- </para>
- <para>
-The purpose of CDL is to enable the interactions between a collection of peer to peer services to be described from a neutral (or global) perspective. This is different to other standards, such as WS-BPEL, that describe interactions from a service specific viewpoint.
- </para>
- <para>
-In essence a choreography description declares roles which will pass messages between each other, called interactions. The interactions are ordered based on a number of structuring mechanism which enables loops, conditional, choices and parallelism to be described. In CDL variables used for messages and for conditionals are all situated at roles. There is no shared state rather there is a precise description of the state at each role and a precise description of how these roles interact in order to reach some notion of common state in which information is exchanged and processed between them.
- </para>
- <para>
-In CDL we use interactions and these structuring mechanisms to describe the observable behaviour, the messages exchanges and the rules for those exchanges and any supporting observable state on which they depend, of a system.
- </para>
- </section>
-
- <section>
- <title>pi4soa</title>
- <para>
-<emphasis>pi4soa</emphasis> is an open source project established to demonstrate the potential benefits that a global model (as described using CDL) can provide when building an SOA. The open source project is managed by the Pi4 Technologies Foundation, which is a collaboration between industry and academia.
- </para>
- <para>
-Building complex distributed systems, without introducing unintended consequences, is a real challenge. Although the Choreography Description Language provides a means of describing complex systems at a higher level, and therefore help to reduce such complexity, it does not necessarily guarantee that erronous situations cannot occur due to inappropriately specified interactions. The research, being carried out by members of the Pi4 Technologies Foundation, into the global model and endpoint projection is targeted at identifying potential unintended consequences, to ensure that a global description of a system can be reliably executed and can be free from unintended consequences.
- </para>
- <para>
-The tool suite currently offers the ability to:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- Define a choreography description
- </listitem>
- <listitem>
- Export the description to a range of other formats, such as BPMN, UML activity/state/sequence models, and HTML
- </listitem>
- <listitem>
- Define scenarios (equivalent to sequence diagrams), with example messages, which can then be simulated against an associated choreography
- </listitem>
- <listitem>
- Generate template endpoint implementations:
- <para>
- <itemizedlist>
- <listitem>
- WS-BPEL for deployment in ActiveBPEL
- </listitem>
- <listitem>
- Java stubs for execution with the pi4soa state machine, with deployment options for Apache Axis, J2EE (JBoss, Glassfish) and JBoss ESB
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
-
- <section>
- <title> SOA Lifecycle Governance </title>
-
- <section>
- <title>Design Time Governance</title>
- <para>
- Design-time governance is concerned with ensuring that the resulting system correctly implements requirements (whether functional or non-functional).
- A choreography description can be used to ensure that the implemented system meets the behavioural requirements.
- </para>
- <para>
- The behavioural requirements can be captured as a collection of scenarios (e.g. sequence diagrams) with associated example messages.
- This enables an unambiguous representation of the business requirements to be stored in a machine processable form, which can subsequently
- be used to validate other phases of the SOA lifecycle.
- </para>
- <para>
- Once the choreography description for the SOA has been defined, it can be validated against the scenarios,
- to ensure that the choreography correctly handles all of the business requirements.
- </para>
- <para>
- Once the service enters the implementation phase, it is important to ensure that it continues to adhere to the design
- and therefore meets the business requirements. Currently this is achieved through the use of techniques such as continuous testing.
- However this is only as reliable as the quality of the unit tests that have been written.
- </para>
- <para>
- When a 'structured' implementation language has been used, such as WS-BPEL, jPDL or the new 'conversation aware' ESB actions,
- it will be possible to infer the behaviour of the service being implemented, to compare it against the choreography description.
- Currently this has been implemented for the “conversation aware” ESB actions, and is demonstrated using the samples in this Overlord-CDL distribution.
- </para>
- <para>
- Detecting incorrectly implemented behaviour at the earliest possible time saves on downstream costs associated with finding and fixing errors.
- By using static validation against the original design, it ensures that the implemented service will deliver its expected behaviour first time.
- This is important in building large scale SOAs where different services may be implemented in different locations.
- </para>
- <para>
- There are two other areas where a choreography description can be used as part of design-time governance,
- that are not currently implemented in Overlord:
- </para>
- <itemizedlist>
- <listitem>
- Service lookup – the choreography description can be used to determine if a service already exists in the Service Repository that meets the appropriate behavioural requirements.
- </listitem>
- <listitem>
- Service unit testing - this can be achieved using the scenarios originally specified to document the behavioural requirements.
- Rather than develop an independent source of test data, the scenarios can be used to validate the sequence of messages sent to,
- and received from, a service, as well as validating the contents of the messages returned from the service under test.
- </listitem>
- </itemizedlist>
- </section>
-
- <section>
- <title>Runtime Governance</title>
- <para>
- Runtime governance ensures that the SOA executes as expected according to predefined policies. In this context, a choreography description can be used in two ways.
- </para>
-
- <section>
- <title> Service validator</title>
- <para>
- The choreography description represents the interactions between multiple services to deliver a business goal.
- To validate the behaviour of each individual service, within the choreography description, the behaviour of each service can be derived from the choreography.
- </para>
- <para>
- The derived behaviour (or “endpoint projection”) of a service can be used within a 'service validator' to monitor the inbound and outbound messages for the service,
- to ensure they conform to the expected behaviour.
- If an invalid message is detected, it would be possible to block it, to prevent it from causing subsequent problems in downstream systems.
- The error can also be reported to a central management capability.
- </para>
- <para>
- The CDL component of Overlord provides the ability to configure service validators to monitor the behaviour of individual services.
- An enhanced version of the JBossESB trailblazer example has been included, with the appropriate validator configuration, to demonstrate this mechanism.
- </para>
- </section>
-
- <section>
- <title>Process correlation</title>
- <para>
- Validating each service locally can enable errors to be detected quickly,
- and the effects of the error prevented from contaminating other systems by blocking the erroneous messages.
- </para>
- <para>
- However local service specific validation may not be adequate to identify errors that would affect the end-to-end business process.
- Therefore the message activity at each service validator can be reported to a central 'process correlation engine' which can reconstitute a global view of the business transaction,
- and determine if it matches the expected behaviour as defined in the choreography description.
- </para>
- <para>
- The benefit of a correlated global view of the distributed business transaction is that it can be further analysed to ensure other governance polices have been followed – e.g. SLAs.
- </para>
- <para>
- The pi4soa tool suite includes a simple GUI based monitoring tool to display the information obtained from correlating message events associated with individual services.
- The trailblazer example has been written to cause out of sequence messages under certain circumstances. See the “Samples Guide” for more information on how to run this example.
- </para>
- </section>
- </section>
- </section>
-
- <section>
- <title> First Steps </title>
- <para>The first step will be to follow the instructions in the next chapter to install Overlord. </para>
- <para> Once installed, the next step should be to try out the examples in the samples folder. The examples consistent of:</para>
- <itemizedlist>
- <listitem>
- Service Validation related examples
- <para>
- The samples folder contains an enhanced version of the trailblazer example from the JBossESB, with the addition of a File Based Bank, and message content including a conversation id to enable the messages to be correlated with a specific session.
- </para>
- </listitem>
- <listitem>
- Conversation aware ESB actions, with conformance checking against Choreography
- <para>
- Two examples have been included, one simple example (purchasing) and the other more advanced (brokerage). Both relate to the business process of purchasing items. The second example introduces the concept of a broker to act on behalf of the customer, interacting with multiple potential suppliers.
- </para>
- <para>
- These examples show how a service implementation (built using “conversation aware ESB actions” in this case), can be continuously checked for conformance against a choreography description.
- </para>
- <para>
- The final step should be to review the other documents in the docs folder to understand more about each capability, and then try using the techniques on your own project.
- </para>
- </listitem>
- </itemizedlist>
- </section>
</chapter>
Modified: cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml
===================================================================
--- cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml 2008-11-11 09:36:40 UTC (rev 431)
+++ cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml 2008-11-11 10:29:23 UTC (rev 432)
@@ -4,5 +4,204 @@
<chapter id="overview">
<title>Overview</title>
-
+ <para>
+ The CDL component of the Overlord SOA governance project aims to leverage the concept of a choreography (or conversation)
+ description to provide design-time and run-time governance of an SOA.
+ </para>
+ <para>
+ A Choreography provides the means to describe the service interactions between multiple parties from a global (or service neutral) perspective.
+ This means that it is possible for an organisation to define how an end-to-end business process should function, regardless of whether orchestrated
+ or peer-to-peer service collaboration will be used.
+ </para>
+ <para>
+ Although in simple situations, a BPEL process description can provide a description of the interactions between multiple services, this only works where a
+ single orchestrating process is in control. The benefit of the choreography description is that it can be used to provide a global view of a process across multiple
+ orchestrated service domains.
+ </para>
+ <para>
+ This document will outline how the Choreography Description is being used as part of Project Overlord to provide SOA governance capabilities
+ for each phase of the SOA lifecycle.
+ </para>
+ <para>
+ When a validated design has been approved by the users, it can be used to generate an initial skeleton of the implementation for each service.
+ The current version of Overlord enables a skeleton implementation to be generated as a JBossESB service configuration file,
+ using 'conversation aware' ESB actions. For more information on these, please see the “Conversational ESB User Guide”.
+ </para>
+
+ <section>
+ <title>WS-CDL</title>
+
+ <para>
+WS-CDL, or Web Service Choreography Description Language, is a candidate recommendation from W3C. Although associated with W3C and Web Services, it is important to begin by stating that the Choreography Description Language (CDL) is <emphasis role="bold">not</emphasis> web service specific.
+ </para>
+ <para>
+The purpose of CDL is to enable the interactions between a collection of peer to peer services to be described from a neutral (or global) perspective. This is different to other standards, such as WS-BPEL, that describe interactions from a service specific viewpoint.
+ </para>
+ <para>
+In essence a choreography description declares roles which will pass messages between each other, called interactions. The interactions are ordered based on a number of structuring mechanism which enables loops, conditional, choices and parallelism to be described. In CDL variables used for messages and for conditionals are all situated at roles. There is no shared state rather there is a precise description of the state at each role and a precise description of how these roles interact in order to reach some notion of common state in which information is exchanged and processed between them.
+ </para>
+ <para>
+In CDL we use interactions and these structuring mechanisms to describe the observable behaviour, the messages exchanges and the rules for those exchanges and any supporting observable state on which they depend, of a system.
+ </para>
+ </section>
+
+ <section>
+ <title>pi4soa</title>
+ <para>
+<emphasis>pi4soa</emphasis> is an open source project established to demonstrate the potential benefits that a global model (as described using CDL) can provide when building an SOA. The open source project is managed by the Pi4 Technologies Foundation, which is a collaboration between industry and academia.
+ </para>
+ <para>
+Building complex distributed systems, without introducing unintended consequences, is a real challenge. Although the Choreography Description Language provides a means of describing complex systems at a higher level, and therefore help to reduce such complexity, it does not necessarily guarantee that erronous situations cannot occur due to inappropriately specified interactions. The research, being carried out by members of the Pi4 Technologies Foundation, into the global model and endpoint projection is targeted at identifying potential unintended consequences, to ensure that a global description of a system can be reliably executed and can be free from unintended consequences.
+ </para>
+ <para>
+The tool suite currently offers the ability to:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ Define a choreography description
+ </listitem>
+ <listitem>
+ Export the description to a range of other formats, such as BPMN, UML activity/state/sequence models, and HTML
+ </listitem>
+ <listitem>
+ Define scenarios (equivalent to sequence diagrams), with example messages, which can then be simulated against an associated choreography
+ </listitem>
+ <listitem>
+ Generate template endpoint implementations:
+ <para>
+ <itemizedlist>
+ <listitem>
+ WS-BPEL for deployment in ActiveBPEL
+ </listitem>
+ <listitem>
+ Java stubs for execution with the pi4soa state machine, with deployment options for Apache Axis, J2EE (JBoss, Glassfish) and JBoss ESB
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section>
+ <title> SOA Lifecycle Governance </title>
+
+ <section>
+ <title>Design Time Governance</title>
+ <para>
+ Design-time governance is concerned with ensuring that the resulting system correctly implements requirements (whether functional or non-functional).
+ A choreography description can be used to ensure that the implemented system meets the behavioural requirements.
+ </para>
+ <para>
+ The behavioural requirements can be captured as a collection of scenarios (e.g. sequence diagrams) with associated example messages.
+ This enables an unambiguous representation of the business requirements to be stored in a machine processable form, which can subsequently
+ be used to validate other phases of the SOA lifecycle.
+ </para>
+ <para>
+ Once the choreography description for the SOA has been defined, it can be validated against the scenarios,
+ to ensure that the choreography correctly handles all of the business requirements.
+ </para>
+ <para>
+ Once the service enters the implementation phase, it is important to ensure that it continues to adhere to the design
+ and therefore meets the business requirements. Currently this is achieved through the use of techniques such as continuous testing.
+ However this is only as reliable as the quality of the unit tests that have been written.
+ </para>
+ <para>
+ When a 'structured' implementation language has been used, such as WS-BPEL, jPDL or the new 'conversation aware' ESB actions,
+ it will be possible to infer the behaviour of the service being implemented, to compare it against the choreography description.
+ Currently this has been implemented for the “conversation aware” ESB actions, and is demonstrated using the samples in this Overlord-CDL distribution.
+ </para>
+ <para>
+ Detecting incorrectly implemented behaviour at the earliest possible time saves on downstream costs associated with finding and fixing errors.
+ By using static validation against the original design, it ensures that the implemented service will deliver its expected behaviour first time.
+ This is important in building large scale SOAs where different services may be implemented in different locations.
+ </para>
+ <para>
+ There are two other areas where a choreography description can be used as part of design-time governance,
+ that are not currently implemented in Overlord:
+ </para>
+ <itemizedlist>
+ <listitem>
+ Service lookup – the choreography description can be used to determine if a service already exists in the Service Repository that meets the appropriate behavioural requirements.
+ </listitem>
+ <listitem>
+ Service unit testing - this can be achieved using the scenarios originally specified to document the behavioural requirements.
+ Rather than develop an independent source of test data, the scenarios can be used to validate the sequence of messages sent to,
+ and received from, a service, as well as validating the contents of the messages returned from the service under test.
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>Runtime Governance</title>
+ <para>
+ Runtime governance ensures that the SOA executes as expected according to predefined policies. In this context, a choreography description can be used in two ways.
+ </para>
+
+ <section>
+ <title> Service validator</title>
+ <para>
+ The choreography description represents the interactions between multiple services to deliver a business goal.
+ To validate the behaviour of each individual service, within the choreography description, the behaviour of each service can be derived from the choreography.
+ </para>
+ <para>
+ The derived behaviour (or “endpoint projection”) of a service can be used within a 'service validator' to monitor the inbound and outbound messages for the service,
+ to ensure they conform to the expected behaviour.
+ If an invalid message is detected, it would be possible to block it, to prevent it from causing subsequent problems in downstream systems.
+ The error can also be reported to a central management capability.
+ </para>
+ <para>
+ The CDL component of Overlord provides the ability to configure service validators to monitor the behaviour of individual services.
+ An enhanced version of the JBossESB trailblazer example has been included, with the appropriate validator configuration, to demonstrate this mechanism.
+ </para>
+ </section>
+
+ <section>
+ <title>Process correlation</title>
+ <para>
+ Validating each service locally can enable errors to be detected quickly,
+ and the effects of the error prevented from contaminating other systems by blocking the erroneous messages.
+ </para>
+ <para>
+ However local service specific validation may not be adequate to identify errors that would affect the end-to-end business process.
+ Therefore the message activity at each service validator can be reported to a central 'process correlation engine' which can reconstitute a global view of the business transaction,
+ and determine if it matches the expected behaviour as defined in the choreography description.
+ </para>
+ <para>
+ The benefit of a correlated global view of the distributed business transaction is that it can be further analysed to ensure other governance polices have been followed – e.g. SLAs.
+ </para>
+ <para>
+ The pi4soa tool suite includes a simple GUI based monitoring tool to display the information obtained from correlating message events associated with individual services.
+ The trailblazer example has been written to cause out of sequence messages under certain circumstances. See the “Samples Guide” for more information on how to run this example.
+ </para>
+ </section>
+ </section>
+ </section>
+
+ <section>
+ <title> First Steps </title>
+ <para>The first step will be to follow the instructions in the Getting Started Guide to install Overlord. </para>
+ <para> Once installed, the next step should be to try out the examples in the samples folder. The examples consistent of:</para>
+ <itemizedlist>
+ <listitem>
+ Service Validation related examples
+ <para>
+ The samples folder contains an enhanced version of the trailblazer example from the JBossESB, with the addition of a File Based Bank, and message content including a conversation id to enable the messages to be correlated with a specific session.
+ </para>
+ </listitem>
+ <listitem>
+ Conversation aware ESB actions, with conformance checking against Choreography
+ <para>
+ Two examples have been included, one simple example (purchasing) and the other more advanced (brokerage). Both relate to the business process of purchasing items. The second example introduces the concept of a broker to act on behalf of the customer, interacting with multiple potential suppliers.
+ </para>
+ <para>
+ These examples show how a service implementation (built using “conversation aware ESB actions” in this case), can be continuously checked for conformance against a choreography description.
+ </para>
+ <para>
+ The final step should be to review all of the documents in the docs folder to understand more about each capability, and then try using the techniques on your own project.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
</chapter>
15 years, 5 months
- 1
- 0
Overlord SVN: r431 - in cdl/trunk/distribution/src/main: release/install and 1 other directory.
by overlord-commits＠lists.jboss.org
Author: jeff.yuchang
Date: 2008-11-11 04:36:40 -0500 (Tue, 11 Nov 2008)
New Revision: 431
Added:
cdl/trunk/distribution/src/main/release/install/README.txt
Removed:
cdl/trunk/distribution/src/main/release/install/readme.txt
Modified:
cdl/trunk/distribution/src/main/assembly/bin.xml
Log:
* Add the gettingstartedguide into the distribution build.
* Update the readme to be capitalized.
Modified: cdl/trunk/distribution/src/main/assembly/bin.xml
===================================================================
--- cdl/trunk/distribution/src/main/assembly/bin.xml 2008-11-11 09:26:27 UTC (rev 430)
+++ cdl/trunk/distribution/src/main/assembly/bin.xml 2008-11-11 09:36:40 UTC (rev 431)
@@ -69,6 +69,12 @@
<outputDirectory>docs/samplesguide</outputDirectory>
</fileSet>
+ <fileSet>
+ <directory>../docs/docbook/gettingstartedguide/target/docbook/publish/en-US</directory>
+ <outputDirectory>docs/gettingstartedguide</outputDirectory>
+ </fileSet>
+
+
<fileSet>
<directory>../runtime/jbossesb/target/javadoc</directory>
<outputDirectory>docs/jbossesb-javadoc</outputDirectory>
Copied: cdl/trunk/distribution/src/main/release/install/README.txt (from rev 430, cdl/trunk/distribution/src/main/release/install/readme.txt)
===================================================================
--- cdl/trunk/distribution/src/main/release/install/README.txt (rev 0)
+++ cdl/trunk/distribution/src/main/release/install/README.txt 2008-11-11 09:36:40 UTC (rev 431)
@@ -0,0 +1,3 @@
+The build.xml script in this directory is responsible for deploying the validator and conversational runtime for JBoss ESB.
+
+The usage and instructions please refer to $doc/gettingstartedguide Installation chapter for detail.
Deleted: cdl/trunk/distribution/src/main/release/install/readme.txt
===================================================================
--- cdl/trunk/distribution/src/main/release/install/readme.txt 2008-11-11 09:26:27 UTC (rev 430)
+++ cdl/trunk/distribution/src/main/release/install/readme.txt 2008-11-11 09:36:40 UTC (rev 431)
@@ -1,3 +0,0 @@
-The build.xml script in this directory is responsible for deploying the validator and conversational runtime for JBoss ESB.
-
-The usage and instructions please refer to $doc/GettingStartedGuide Installation chapter for detail.
15 years, 5 months
- 1
- 0
Overlord SVN: r430 - in cdl/trunk: docs/docbook/gettingstartedguide/src/main and 1 other directories.
by overlord-commits＠lists.jboss.org
Author: jeff.yuchang
Date: 2008-11-11 04:26:27 -0500 (Tue, 11 Nov 2008)
New Revision: 430
Added:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/appendix.xml
Modified:
cdl/trunk/distribution/src/main/release/install/readme.txt
cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml
cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml
Log:
* Add appendix, including advanced options of installation.
* Update the install/readme.txt.
Modified: cdl/trunk/distribution/src/main/release/install/readme.txt
===================================================================
--- cdl/trunk/distribution/src/main/release/install/readme.txt 2008-11-11 04:07:30 UTC (rev 429)
+++ cdl/trunk/distribution/src/main/release/install/readme.txt 2008-11-11 09:26:27 UTC (rev 430)
@@ -1,13 +1,3 @@
The build.xml script in this directory is responsible for deploying the validator and conversational runtime for JBoss ESB.
-Deployment into JBoss ESB 4.4.GA
-=================================
- - Install JBoss 4.2.2.GA into an appropriate location.
- - Install JBoss ESB 4.4.GA into a location. Then follow the instructions in the JBossESB installation (install/readme.txt) to deploy
- JBossESb into the JBossAS environment.
- - Edit the deployment.properties file to update the JBossAS and JBossESB location settings.
- - Run 'ant deploy' to deploy both the Overlord CDL conversational ESB actions and service validation capabilities.
- OR Run 'ant deploy-overlord-cdl-runtime' to deploy just the conversational ESB actions support.
- OR Run 'ant deploy-overlord-cdl-validator' to deploy just the service validation capability.
-
-For more detail, please refer to $doc/userguide GettingStarted chapter.
+The usage and instructions please refer to $doc/GettingStartedGuide Installation chapter for detail.
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2008-11-11 04:07:30 UTC (rev 429)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2008-11-11 09:26:27 UTC (rev 430)
@@ -15,5 +15,5 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/soagwithcdl.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/conversation-validation-with-cdl.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/conversation-aware-esb.xml"/>
-
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/appendix.xml"/>
</book>
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/appendix.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/appendix.xml (rev 0)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/appendix.xml 2008-11-11 09:26:27 UTC (rev 430)
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="appendix">
+ <title>Appendix</title>
+
+ <section>
+ <title>Advanced options of installation</title>
+ <para>
+ The Overlord CDL has two separate modules. One is <emphasis role="bold">Validator</emphasis> module, which is used from management perspective;
+ The other is the <emphasis role="bold">Runtime</emphasis> module, which is used for execution of flow/interaction sections of CDL file.
+ </para>
+ <para>
+ You can deploy each of them separately in the <emphasis role="bold">Install</emphasis> folder.
+ From the install folder.
+ <itemizedlist>
+ <listitem>
+ Run: <command> ant deploy-overlord-cdl-runtime</command> to deploy just the conversational ESB actions support. Or
+ </listitem>
+ <listitem>
+ Run: <command>ant deploy-overlord-cdl-validator</command> to to deploy just the service validation capability.
+ </listitem>
+ </itemizedlist>
+ By default, when you run <command>ant </command> or <command>ant deploy</command>, it will deploy both of two modules.
+ </para>
+
+ <para>
+ Also, you can undeploy modules by running <command>ant undeploy</command>. Or remove them module by module through running:
+ <command>ant undeploy-overlord-cdl-runtime</command> and <command>ant undeploy-overlord-cdl-validator</command>
+ </para>
+
+ </section>
+
+</chapter>
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2008-11-11 04:07:30 UTC (rev 429)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2008-11-11 09:26:27 UTC (rev 430)
@@ -20,7 +20,7 @@
<orderedlist>
<listitem>JBossAS (version 4.2.2.GA or higher), available from <ulink url="http://www.jboss.org/jbossas">http://www.jboss.org/jbossas</ulink></listitem>
<listitem>JBossESB (version 4.4.GA or higher), should download the <emphasis role="bold">jbossesb-4.4.GA.zip</emphasis>, available from <ulink url="http://www.jboss.org/jbossesb">http://www.jboss.org/jbossesb</ulink></listitem>
- <listitem>Overlord CDL (version 1.0-SNAPSHOT or higher) </listitem>
+ <listitem>Overlord CDL (version 1.0-M1 or higher), available from <ulink url="http://www.jboss.org/overlord">http://www.jboss.org/overlord</ulink></listitem>
<listitem>
pi4soa (version 2.0.0 or higher), available from <ulink url="http://pi4soa.wiki.sourceforge.net/download">http://pi4soa.wiki.sourceforge.net/download</ulink>
<note>
@@ -61,8 +61,7 @@
Edit the <emphasis role="bold">install/deployment.properties</emphasis> file to update the JBossAS and JBossESB location settings.
</listitem>
<listitem>
- From the install folder, run: <command> ant deploy</command>to deploy both the Overlord CDL conversational ESB actions and service validation capabilities.
- Or <command>ant deploy-overlord-cdl-runtime</command> to deploy just the conversational ESB actions support, or <command>ant deploy-overlord-cdl-validator</command> to deploy just the service validation capability.
+ From the install folder, run: <command>ant</command> to deploy the Overlord CDL to JBossAS.
</listitem>
</itemizedlist>
</para>
15 years, 5 months
- 1
- 0
Overlord SVN: r429 - in cdl/trunk/samples: jbossesb/brokerage/broker/src/main/java/org/jboss/soa/overlord/samples/jbossesb/loan/broker and 1 other directories.
by overlord-commits＠lists.jboss.org
Author: jeff.yuchang
Date: 2008-11-10 23:07:30 -0500 (Mon, 10 Nov 2008)
New Revision: 429
Added:
cdl/trunk/samples/jbossesb/brokerage/broker/src/main/java/org/jboss/soa/overlord/samples/jbossesb/loan/broker/SetOrderRejectMessageAction.java
Modified:
cdl/trunk/samples/jbossesb/brokerage/broker/src/main/resources/META-INF/jboss-esb.xml
cdl/trunk/samples/pom.xml
Log:
* Add credit card ageny false branch.
Added: cdl/trunk/samples/jbossesb/brokerage/broker/src/main/java/org/jboss/soa/overlord/samples/jbossesb/loan/broker/SetOrderRejectMessageAction.java
===================================================================
--- cdl/trunk/samples/jbossesb/brokerage/broker/src/main/java/org/jboss/soa/overlord/samples/jbossesb/loan/broker/SetOrderRejectMessageAction.java (rev 0)
+++ cdl/trunk/samples/jbossesb/brokerage/broker/src/main/java/org/jboss/soa/overlord/samples/jbossesb/loan/broker/SetOrderRejectMessageAction.java 2008-11-11 04:07:30 UTC (rev 429)
@@ -0,0 +1,54 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright 2008, JBoss Inc., and others contributors as indicated
+ * by the @authors tag. All rights reserved.
+ * See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ * This copyrighted material is made available to anyone wishing to use,
+ * modify, copy, or redistribute it subject to the terms and conditions
+ * of the GNU Lesser General Public License, v. 2.1.
+ * This program is distributed in the hope that it will be useful, but WITHOUT A
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ * You should have received a copy of the GNU Lesser General Public License,
+ * v.2.1 along with this distribution; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ *
+ * (C) 2008,
+ */
+package org.jboss.soa.overlord.samples.jbossesb.loan.broker;
+
+import org.apache.log4j.Logger;
+import org.jboss.soa.esb.actions.AbstractActionLifecycle;
+import org.jboss.soa.esb.helpers.ConfigTree;
+import org.jboss.soa.esb.message.Message;
+import org.jboss.soa.overlord.jbossesb.util.XMLUtils;
+import org.w3c.dom.Node;
+
+/**
+ * @author jeffyu
+ *
+ */
+public class SetOrderRejectMessageAction extends AbstractActionLifecycle {
+
+ public static Logger logger = Logger.getLogger(SetOrderRejectMessageAction.class);
+
+ private ConfigTree config;
+
+ public SetOrderRejectMessageAction(ConfigTree config){
+ this.config = config;
+ }
+
+ public Message process(Message message) throws Exception {
+ Node node = XMLUtils.getNode((String)message.getBody().get());
+ String idValue = node.getAttributes().getNamedItem("id").getNodeValue();
+
+ message.getBody().add("<orderRejected id=\"" + idValue + "\">Credit Card is invalid!</orderRejected>");
+
+ logger.info(message.getBody().get());
+
+ return message;
+ }
+
+}
Modified: cdl/trunk/samples/jbossesb/brokerage/broker/src/main/resources/META-INF/jboss-esb.xml
===================================================================
--- cdl/trunk/samples/jbossesb/brokerage/broker/src/main/resources/META-INF/jboss-esb.xml 2008-11-10 15:33:53 UTC (rev 428)
+++ cdl/trunk/samples/jbossesb/brokerage/broker/src/main/resources/META-INF/jboss-esb.xml 2008-11-11 04:07:30 UTC (rev 429)
@@ -1,7 +1,6 @@
<?xml version = "1.0" encoding = "UTF-8"?>
<jbossesb xmlns="http://anonsvn.labs.jboss.com/labs/jbossesb/trunk/product/etc/schemas/xml..."
parameterReloadSecs="5000">
-
<providers>
<jms-provider name="JBossMQ" connection-factory="ConnectionFactory"
jndi-context-factory="org.jnp.interfaces.NamingContextFactory"
@@ -613,8 +612,12 @@
</property>
</action>
+ <action class="org.jboss.soa.overlord.samples.jbossesb.loan.broker.SetOrderRejectMessageAction"
+ process="process" name="s14-2">
+ </action>
+
<action class="org.jboss.soa.overlord.jbossesb.actions.SendMessageAction"
- process="process" name="s13-3">
+ process="process" name="s14-3">
<property name="operation" value="buy" />
<property name="messageType" value="orderRejected" />
<property name="clientEPR" value="buyer" />
Modified: cdl/trunk/samples/pom.xml
===================================================================
--- cdl/trunk/samples/pom.xml 2008-11-10 15:33:53 UTC (rev 428)
+++ cdl/trunk/samples/pom.xml 2008-11-11 04:07:30 UTC (rev 429)
@@ -11,12 +11,12 @@
<parent>
<groupId>org.jboss.soa.overlord</groupId>
<artifactId>cdl</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <version>1.0-M1</version>
</parent>
<properties>
- <deploy.dir>/var/local/jboss/server/default/deploy</deploy.dir>
- <cdl.jbossesb.version>1.0-SNAPSHOT</cdl.jbossesb.version>
+ <deploy.dir>/var/local/jboss-4.2.2.GA/server/default/deploy</deploy.dir>
+ <cdl.jbossesb.version>1.0-M1</cdl.jbossesb.version>
</properties>
15 years, 5 months
- 1
- 0
Overlord SVN: r428 - in cdl/trunk: docs/docbook/gettingstartedguide/src/main and 3 other directories.
by overlord-commits＠lists.jboss.org
Author: objectiser
Date: 2008-11-10 10:33:53 -0500 (Mon, 10 Nov 2008)
New Revision: 428
Added:
cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml
cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml
Removed:
cdl/trunk/docs/docbook/userguide/src/main/module/installation.xml
Modified:
cdl/trunk/distribution/src/main/release/README.txt
cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml
cdl/trunk/docs/docbook/userguide/src/main/master.xml
Log:
Moved the installation chapter from User Guide to Getting Started Guide.
Modified: cdl/trunk/distribution/src/main/release/README.txt
===================================================================
--- cdl/trunk/distribution/src/main/release/README.txt 2008-11-10 15:12:38 UTC (rev 427)
+++ cdl/trunk/distribution/src/main/release/README.txt 2008-11-10 15:33:53 UTC (rev 428)
@@ -1,13 +1,14 @@
Overlord CDL README
===================
-Please refer to the Installation section, within the User Guide in the docs folder,
-which explains how to install the Overlord CDL governance capabilities into the
+Please refer to the Installation section, within the Getting Started Guide in the docs
+folder, which explains how to install the Overlord CDL governance capabilities into the
JBossESB environment.
+If you are new to SOA Governance using CDL, then please refer to the Getting Started
+Guide in the docs folder. Otherwise more detailed information can be found in the
+User Guide within the docs folder.
+
The Samples Guide in the docs folder explains how to run some examples demonstrating
the CDL based Governance capabilities.
-If you are new to SOA Governance using CDL, then please refer to the Getting Started
-Guide in the docs folder.
-
Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2008-11-10 15:12:38 UTC (rev 427)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2008-11-10 15:33:53 UTC (rev 428)
@@ -11,6 +11,7 @@
</bookinfo>
<toc/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/installation.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/soagwithcdl.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/conversation-validation-with-cdl.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/conversation-aware-esb.xml"/>
Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml
===================================================================
--- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml (rev 0)
+++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2008-11-10 15:33:53 UTC (rev 428)
@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="installation">
+ <title>Installation</title>
+
+ <section>
+ <title> Overview </title>
+ <para>
+ This section describes the installation procedure for the Overlord CDL based governance capabilities. These capabilities are:
+ </para>
+ <itemizedlist>
+ <listitem> Conversation aware ESB Actions with conformance checking against a Choreography Description </listitem>
+ <listitem> ESB Service validation against a Choreography Description </listitem>
+ </itemizedlist>
+ </section>
+
+ <section>
+ <title>Prerequisites</title>
+ <orderedlist>
+ <listitem>JBossAS (version 4.2.2.GA or higher), available from <ulink url="http://www.jboss.org/jbossas">http://www.jboss.org/jbossas</ulink></listitem>
+ <listitem>JBossESB (version 4.4.GA or higher), should download the <emphasis role="bold">jbossesb-4.4.GA.zip</emphasis>, available from <ulink url="http://www.jboss.org/jbossesb">http://www.jboss.org/jbossesb</ulink></listitem>
+ <listitem>Overlord CDL (version 1.0-SNAPSHOT or higher) </listitem>
+ <listitem>
+ pi4soa (version 2.0.0 or higher), available from <ulink url="http://pi4soa.wiki.sourceforge.net/download">http://pi4soa.wiki.sourceforge.net/download</ulink>
+ <note>
+ <para>
+ It is recommended that a pre-packaged version is used, which includes all of the necessary Eclipse related plugins.
+ However the plugins can be installed separately into an existing Eclipse environment by following the instructions on the <ulink url="http://www.pi4soa.org">http://www.pi4soa.org</ulink> download wiki.
+ </para>
+ </note>
+ </listitem>
+ <listitem>
+ Ant, available from <ulink url="http://ant.apache.org/">http://ant.apache.org</ulink>
+ </listitem>
+ </orderedlist>
+ </section>
+
+ <section>
+ <title>Installation Instructions</title>
+ <orderedlist>
+ <listitem>
+ Install JBossAS
+ <para> Unpack the JBossAS installation into the required location. </para>
+ </listitem>
+ <listitem>
+ Install JBossESB
+ <para> Unpack the JBossESB installation into a location alongside the JBossAS installation.
+ Then follow the instructions in the JBossESB installation (install/readme.txt), to deploy JBossESB into the JBossAS environment.
+ </para>
+ </listitem>
+
+ <listitem>
+ Install the Overlord CDL distribution
+ <para>
+ Unpack the Overlord CDL distribution into a location alongside the JBossAS installation.
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ Edit the <emphasis role="bold">install/deployment.properties</emphasis> file to update the JBossAS and JBossESB location settings.
+ </listitem>
+ <listitem>
+ From the install folder, run: <command> ant deploy</command>to deploy both the Overlord CDL conversational ESB actions and service validation capabilities.
+ Or <command>ant deploy-overlord-cdl-runtime</command> to deploy just the conversational ESB actions support, or <command>ant deploy-overlord-cdl-validator</command> to deploy just the service validation capability.
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+
+ <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>
+ <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:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ Start the Eclipse environment
+ </listitem>
+ <listitem>
+ Select the “Help - > Software Updates...” menu item
+ </listitem>
+ <listitem>
+ From the <emphasis role="bold"> Available Software</emphasis> tab, press the “Add Site...” button
+ </listitem>
+ <listitem>
+ Press the <emphasis role="bold">“Local”</emphasis> button, browse to locate the <emphasis role="bold">tools</emphasis> folder in the Overlord CDL distribution,
+ and then press the OK button. This will cause the local Eclipse update site, bundled with the Overlord CDL distribution, to be add to the <emphasis role="bold"> Available Software </emphasis> tab.
+ </listitem>
+ <listitem>
+ Select the root node of the newly added local update site, and then press the <emphasis role="bold">“Install”</emphasis> button and follow the instructions to install the plugins.
+
+ <note>
+ <para>
+ An eclipse issue occasionally causes the nodes under the checked root node
+ to become unchecked, resulting in the software update manager indicating
+ that no plugins need to be installed. If this happens, simply uncheck the
+ root node, and then re-check the root node and press the
+ <emphasis role="bold">“Install”</emphasis> button again.
+ </para>
+ </note>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+
+ </orderedlist>
+ </section>
+
+</chapter>
Modified: cdl/trunk/docs/docbook/userguide/src/main/master.xml
===================================================================
--- cdl/trunk/docs/docbook/userguide/src/main/master.xml 2008-11-10 15:12:38 UTC (rev 427)
+++ cdl/trunk/docs/docbook/userguide/src/main/master.xml 2008-11-10 15:33:53 UTC (rev 428)
@@ -11,7 +11,7 @@
</bookinfo>
<toc/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/installation.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/overview.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/conversation-validation-with-cdl.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/conversation-aware-esb.xml"/>
Deleted: cdl/trunk/docs/docbook/userguide/src/main/module/installation.xml
===================================================================
--- cdl/trunk/docs/docbook/userguide/src/main/module/installation.xml 2008-11-10 15:12:38 UTC (rev 427)
+++ cdl/trunk/docs/docbook/userguide/src/main/module/installation.xml 2008-11-10 15:33:53 UTC (rev 428)
@@ -1,115 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-]>
-<chapter id="installation">
- <title>Installation</title>
-
- <section>
- <title> Overview </title>
- <para>
- This section describes the installation procedure for the Overlord CDL based governance capabilities. These capabilities are:
- </para>
- <itemizedlist>
- <listitem> Conversation aware ESB Actions with conformance checking against a Choreography Description </listitem>
- <listitem> ESB Service validation against a Choreography Description </listitem>
- </itemizedlist>
- </section>
-
- <section>
- <title>Prerequisites</title>
- <orderedlist>
- <listitem>JBossAS (version 4.2.2.GA or higher), available from <ulink url="http://www.jboss.org/jbossas">http://www.jboss.org/jbossas</ulink></listitem>
- <listitem>JBossESB (version 4.4.GA or higher), should download the <emphasis role="bold">jbossesb-4.4.GA.zip</emphasis>, available from <ulink url="http://www.jboss.org/jbossesb">http://www.jboss.org/jbossesb</ulink></listitem>
- <listitem>Overlord CDL (version 1.0-SNAPSHOT or higher) </listitem>
- <listitem>
- pi4soa (version 2.0.0 or higher), available from <ulink url="http://pi4soa.wiki.sourceforge.net/download">http://pi4soa.wiki.sourceforge.net/download</ulink>
- <note>
- <para>
- It is recommended that a pre-packaged version is used, which includes all of the necessary Eclipse related plugins.
- However the plugins can be installed separately into an existing Eclipse environment by following the instructions on the <ulink url="http://www.pi4soa.org">http://www.pi4soa.org</ulink> download wiki.
- </para>
- </note>
- </listitem>
- <listitem>
- Ant, available from <ulink url="http://ant.apache.org/">http://ant.apache.org</ulink>
- </listitem>
- </orderedlist>
- </section>
-
- <section>
- <title>Installation Instructions</title>
- <orderedlist>
- <listitem>
- Install JBossAS
- <para> Unpack the JBossAS installation into the required location. </para>
- </listitem>
- <listitem>
- Install JBossESB
- <para> Unpack the JBossESB installation into a location alongside the JBossAS installation.
- Then follow the instructions in the JBossESB installation (install/readme.txt), to deploy JBossESB into the JBossAS environment.
- </para>
- </listitem>
-
- <listitem>
- Install the Overlord CDL distribution
- <para>
- Unpack the Overlord CDL distribution into a location alongside the JBossAS installation.
- </para>
- <para>
- <itemizedlist>
- <listitem>
- Edit the <emphasis role="bold">install/deployment.properties</emphasis> file to update the JBossAS and JBossESB location settings.
- </listitem>
- <listitem>
- From the install folder, run: <command> ant deploy</command>to deploy both the Overlord CDL conversational ESB actions and service validation capabilities.
- Or <command>ant deploy-overlord-cdl-runtime</command> to deploy just the conversational ESB actions support, or <command>ant deploy-overlord-cdl-validator</command> to deploy just the service validation capability.
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <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>
- <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:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- Start the Eclipse environment
- </listitem>
- <listitem>
- Select the “Help - > Software Updates...” menu item
- </listitem>
- <listitem>
- From the <emphasis role="bold"> Available Software</emphasis> tab, press the “Add Site...” button
- </listitem>
- <listitem>
- Press the <emphasis role="bold">“Local”</emphasis> button, browse to locate the <emphasis role="bold">tools</emphasis> folder in the Overlord CDL distribution,
- and then press the OK button. This will cause the local Eclipse update site, bundled with the Overlord CDL distribution, to be add to the <emphasis role="bold"> Available Software </emphasis> tab.
- </listitem>
- <listitem>
- Select the root node of the newly added local update site, and then press the <emphasis role="bold">“Install”</emphasis> button and follow the instructions to install the plugins.
-
- <note>
- <para>
- An eclipse issue occasionally causes the nodes under the checked root node
- to become unchecked, resulting in the software update manager indicating
- that no plugins need to be installed. If this happens, simply uncheck the
- root node, and then re-check the root node and press the
- <emphasis role="bold">“Install”</emphasis> button again.
- </para>
- </note>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- </orderedlist>
- </section>
-
-</chapter>
Added: cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml
===================================================================
--- cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml (rev 0)
+++ cdl/trunk/docs/docbook/userguide/src/main/module/overview.xml 2008-11-10 15:33:53 UTC (rev 428)
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<chapter id="overview">
+ <title>Overview</title>
+
+
+</chapter>
15 years, 5 months
- 1
- 0