12:57 p.m.
Author: objectiser
Date: 2010-06-06 13:57:09 -0400 (Sun, 06 Jun 2010)
New Revision: 249
Removed:
trunk/tools/eclipse/eclipse-build/
trunk/tools/eclipse/pom.xml
Modified:
trunk/docs/gettingstartedguide/src/main/module/installation.xml
trunk/docs/gettingstartedguide/src/main/module/servicedev.xml
trunk/tools/pom.xml
Log:
Remove the older approach for building the Eclipse plugins bundled in the distribution.
Now built as separate update site. Also removed some reference to the 'conversation
aware' ESB actions.
Modified: trunk/docs/gettingstartedguide/src/main/module/installation.xml
===================================================================
--- trunk/docs/gettingstartedguide/src/main/module/installation.xml 2010-06-06 15:48:18
UTC (rev 248)
+++ trunk/docs/gettingstartedguide/src/main/module/installation.xml 2010-06-06 17:57:09
UTC (rev 249)
@@ -15,7 +15,7 @@
</para>
<orderedlist>
<listitem>Eclipse JEE (3.5 or higher) <ulink
url="http://www.eclipse.org">http://www.eclipse.org</ulink></listitem>
- <listitem>SAVARA Eclipse Tools (version 1.0-M1 or higher), available from
<ulink
url="http://www.jboss.org/savara">http://www.jboss.org/savar...
+ <listitem>SAVARA (version 1.0-M1 or higher), available from <ulink
url="http://www.jboss.org/savara/downloads">http://www.jboss...
<listitem>JBoss Tools (3.1 or higher) <ulink
url="http://www.jboss.org/tools">http://www.jboss.org/tools&...
available from an update site</listitem>
</orderedlist>
@@ -24,7 +24,7 @@
<section>
<title>Installation Instructions</title>
<para>
- The installation instructions for the SAVARA Eclipse Tools are:
+ The installation instructions for the SAVARA Eclipse tools are:
</para>
<orderedlist>
<listitem>
@@ -35,6 +35,17 @@
</listitem>
<listitem>
+ BPMN Modeller
+ <para>
+ When Eclipse has been lauched, go to the <emphasis>Help->Install New
Software..</emphasis>
+ menu item. Select the Eclipse update site
+ for the version of Eclipse (e.g. Galileo). Within the SOA Development
+ category, select the BPMN feature. Follow the instructions to accept
+ the license and then restart Eclipse after the plugins have been
+ installed.
+ </para>
+ </listitem>
+ <listitem>
JBoss Tools
<para>
Start up your Eclipse environment, and go to the
<emphasis>Help->Install New Software..</emphasis>
@@ -66,21 +77,8 @@
<listitem>
Install SAVARA Eclipse plugins
<para>
- The Eclipse plugins for SAVARA are located in the
<emphasis>eclipse</emphasis>
- folder of the distribution. Copy the contents of the
<emphasis>eclipse</emphasis>
- folder (in the <emphasis>features</emphasis> and
<emphasis>plugins</emphasis>
- sub-folders) into the same sub-folders of your Eclipse installation.
-
- <note>
- <para>
- Version 1.1 of the BPMN editor in Galileo does not correctly display links in
the
- diagram. Therefore we have included an early access release of version 1.2
- with the SAVARA plugins. When version 1.2 of the Eclipse BPMN editor is
- available in the Galileo update site, select the plugins from the SOA
- Development category. Until then, use the plugins provided in the SAVARA
- local update site.
- </para>
- </note>
+ The Eclipse plugins for SAVARA are installed via an update site referenced
+ on the SAVARA <ulink
url="http://www.jboss.org/savara/downloads">download page</ulink>.
</para>
</listitem>
Modified: trunk/docs/gettingstartedguide/src/main/module/servicedev.xml
===================================================================
--- trunk/docs/gettingstartedguide/src/main/module/servicedev.xml 2010-06-06 15:48:18 UTC
(rev 248)
+++ trunk/docs/gettingstartedguide/src/main/module/servicedev.xml 2010-06-06 17:57:09 UTC
(rev 249)
@@ -417,186 +417,6 @@
</section>
<section>
- <title>"Conversation Aware" ESB Actions</title>
-
- <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 and switch.
- </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 preceding artifacts (e.g. service design or choreography
description).
-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>SAVARA->Generate->JBossESB 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>, select the messaging system appropriate for your
target environment 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>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>
-
- <note>
- <para>
- Before you can deploy and run the "conversation aware" ESB example, you
will
- need to install the SAVARA Runtime module for JBossESB.
- </para>
- </note>
-
- <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
SAVARA Runtime for
-JBossESB has been deployed and configured within the JBoss Application
-Server/ESB environment:
- </para>
-
- <orderedlist>
- <listitem>
-In a command window, go to the <filename>${SAVARA-Runtime}/samples</filename>
folder and
-execute <emphasis role="bold">ant deploy-purchasing</emphasis>
- </listitem>
- <listitem>
-In a command window, go to the
<filename>${SAVARA-Runtime}/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>
-
- <para>
-In this example, the conversation ESB actions will do the validation in the runtime.
-As we've said, the client send the 'buyRequest' message to the store,
-firstly the store service will check the received message based on its messageType
attribute.
-and then send another message to the <emphasis>CreditAgency</emphasis>
service it goes
-through its validation.
-If the messageType that <emphasis>Store</emphasis> service received is not as
same
-as the one defined in the "conversation aware" ESB actions, it will throw out
the
-exception and ends its flow.
- </para>
-
- </section>
- </section>
-
- <section>
<title>Summary</title>
<para>
@@ -605,8 +425,8 @@
</para>
<para>
-The aim of these capabilities are to enable verification of an implementation, defined
-using <emphasis>conversation aware</emphasis> ESB actions or BPEL, against a
+The aim of these capabilities are to enable verification of an implementation, initially
+defined just using BPEL process definitions, 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.
Deleted: trunk/tools/eclipse/pom.xml
===================================================================
--- trunk/tools/eclipse/pom.xml 2010-06-06 15:48:18 UTC (rev 248)
+++ trunk/tools/eclipse/pom.xml 2010-06-06 17:57:09 UTC (rev 249)
@@ -1,23 +0,0 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd">
- <modelVersion>4.0.0</modelVersion>
-
- <groupId>org.jboss.savara.tools</groupId>
- <artifactId>eclipse</artifactId>
- <packaging>pom</packaging>
- <name>Savara::Tools::Eclipse</name>
- <version>1.0.0-SNAPSHOT</version>
-
- <parent>
- <groupId>org.jboss.savara</groupId>
- <artifactId>tools</artifactId>
- <version>1.0.0-SNAPSHOT</version>
- </parent>
-
- <modules>
- <module>eclipse-build</module>
- </modules>
-
-</project>
-
Modified: trunk/tools/pom.xml
===================================================================
--- trunk/tools/pom.xml 2010-06-06 15:48:18 UTC (rev 248)
+++ trunk/tools/pom.xml 2010-06-06 17:57:09 UTC (rev 249)
@@ -17,7 +17,6 @@
</parent>
<modules>
- <module>eclipse</module>
</modules>
</project>