[riftsaw-commits] riftsaw SVN: r366 - in trunk/docs/docbook: userguide/src/main and 2 other directories.

Author: objectiser Date: 2009-12-03 07:41:07 -0500 (Thu, 03 Dec 2009) New Revision: 366 Added: trunk/docs/docbook/userguide/src/main/images/EclipseAddRemoveProject.png trunk/docs/docbook/userguide/src/main/images/EclipseHelloWorldDeployed.png trunk/docs/docbook/userguide/src/main/images/EclipseHelloWorldProject.png trunk/docs/docbook/userguide/src/main/images/EclipseHelloWorldResponse.png trunk/docs/docbook/userguide/src/main/images/EclipseImportExistingProjectsIntoWorkspace.png trunk/docs/docbook/userguide/src/main/images/EclipseImportHelloWorld.png trunk/docs/docbook/userguide/src/main/images/EclipseNewServer.png trunk/docs/docbook/userguide/src/main/images/EclipseSendHello.png trunk/docs/docbook/userguide/src/main/module/deploy.xml Modified: trunk/docs/docbook/gettingstartedguide/src/main/module/examples.xml trunk/docs/docbook/userguide/src/main/master.xml trunk/docs/docbook/userguide/src/main/module/admin.xml Log: RIFTSAW-132 - document Eclipse BPEL project deployment approach. Modified: trunk/docs/docbook/gettingstartedguide/src/main/module/examples.xml =================================================================== --- trunk/docs/docbook/gettingstartedguide/src/main/module/examples.xml 2009-12-02 16:34:53 UTC (rev 365) +++ trunk/docs/docbook/gettingstartedguide/src/main/module/examples.xml 2009-12-03 12:41:07 UTC (rev 366) @@ -8,11 +8,22 @@ <title>Overview</title> <para> This chapter provides a getting started guide to the examples. Further information on the individual - examples can be found in the samples folder. This guide will describe one example from each of the - categories - quickstart (pure BPEL) and ESB. + examples can be found in the samples folder. </para> <para> + If using the Eclipse BPEL editor, bundled with + <ulink url="http://www.jboss.org/tools">JBoss Tools</ulink>, then you can import + the quickstart samples as Eclipse BPEL projects, by selecting the <emphasis>import</emphasis> + menu item on the left navigation panel in Eclipse, and choosing the + <emphasis>General->Existing Projects into Workspace</emphasis> option. Then + select the individual sample you wish to import, or alternatively select the + <filename>${RiftSaw}/samples/quickstart</filename> folder to select multiple + (or all) samples for import. Please see the RiftSaw User Guide for information + on how to deploy the BPEL samples to the server. + </para> + + <para> Before deploying any of the examples, you need to start the JBossAS server and ensure that RiftSaw has been installed. This can be achieved by testing whether the Added: trunk/docs/docbook/userguide/src/main/images/EclipseAddRemoveProject.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/EclipseAddRemoveProject.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/EclipseHelloWorldDeployed.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/EclipseHelloWorldDeployed.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/EclipseHelloWorldProject.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/EclipseHelloWorldProject.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/EclipseHelloWorldResponse.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/EclipseHelloWorldResponse.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/EclipseImportExistingProjectsIntoWorkspace.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/EclipseImportExistingProjectsIntoWorkspace.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/EclipseImportHelloWorld.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/EclipseImportHelloWorld.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/EclipseNewServer.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/EclipseNewServer.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/EclipseSendHello.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/EclipseSendHello.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/docs/docbook/userguide/src/main/master.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/master.xml 2009-12-02 16:34:53 UTC (rev 365) +++ trunk/docs/docbook/userguide/src/main/master.xml 2009-12-03 12:41:07 UTC (rev 366) @@ -13,5 +13,6 @@ <toc/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/introduction.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/admin.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/deploy.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/esb.xml"/> </book> Modified: trunk/docs/docbook/userguide/src/main/module/admin.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/module/admin.xml 2009-12-02 16:34:53 UTC (rev 365) +++ trunk/docs/docbook/userguide/src/main/module/admin.xml 2009-12-03 12:41:07 UTC (rev 366) @@ -122,93 +122,4 @@ </section> - <section> - <title>BPEL Process Deployment</title> - - <para> - BPEL processes can be deployed to RiftSaw in two ways: - </para> - - <itemizedlist> - <listitem> - Eclipse BPEL editor with JBoss AS deployment - </listitem> - <listitem> - ANT script based deployment - </listitem> - </itemizedlist> - - <para> - The first approach, using the WTP deployment framework within Eclipse, - is described in the JBoss Tools documentation related to the BPEL - editor support. Please refer to this documentation for further help - using this approach. - </para> - - <para> - The ANT script approach is demonstrated in the quickstart examples. - For example, - </para> - - <informalexample> - <programlisting role="XML" ><![CDATA[ - <!-- Import the base Ant build script... --> - <property file="../../../install/deployment.properties" /> - - <property name="version" value="1" /> - - <property name="server.dir" value="${org.jboss.as.home}/server/${org.jboss.as.config}"/> - <property name="conf.dir" value="${server.dir}/conf"/> - <property name="deploy.dir" value="${server.dir}/deploy"/> - <property name="server.lib.dir" value="${server.dir}/lib"/> - - <property name="sample.jar.name" value="${ant.project.name}-${version}.jar" /> - - <target name="deploy"> - <echo>Deploy ${ant.project.name}</echo> - <jar basedir="bpel" destfile="${deploy.dir}/${sample.jar.name}" /> - </target> - - <target name="undeploy"> - <echo>Undeploy ${ant.project.name}</echo> - <delete file="${deploy.dir}/${sample.jar.name}" /> - </target> - ]]></programlisting> - </informalexample> - - <para> - This excerpt from the ANT build file for the <emphasis>hello_world</emphasis> - quickstart example shows that deploying a RiftSaw BPEL process using ANT - is very straightforward. The main points of interest are: - </para> - - <itemizedlist> - <listitem> - It is necessary to identify the location of the JBoss AS server in which - the BPEL process will be deployed. This is achieved in this example by - referring to the <filename>deployment.properties</filename> file that - has been configured in the RiftSaw distribution (install folder). - </listitem> - <listitem> - If a versioned approach is being used, so that multiple versions of the - same BPEL process may be deployed at one time, then the name of the - archive (jar) containing the BPEL process (and associated artifacts) - has a version number suffix. This would need to be manually incremented - for each distinct version of the BPEL process being deployed. - </listitem> - <listitem> - The next step is to define the <emphasis>deploy</emphasis> target, which - will create the BPEL process archive, using the contents of the bpel - sub-folder in this case, and store it within the JBoss AS - server's <filename>deploy</filename> folder. - </listitem> - <listitem> - The final step is to define the <emphasis>undeploy</emphasis> target, - which simply removes the BPEL process archive from the JBoss AS - server's <filename>deploy</filename> folder. - </listitem> - </itemizedlist> - - </section> - </chapter> Added: trunk/docs/docbook/userguide/src/main/module/deploy.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/module/deploy.xml (rev 0) +++ trunk/docs/docbook/userguide/src/main/module/deploy.xml 2009-12-03 12:41:07 UTC (rev 366) @@ -0,0 +1,209 @@ +<?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="deploy"> + <title>Deploying BPEL Processes</title> + + <section> + <title>Overview</title> + + <para> + This section outlines the mechanisms that can be used to deploy a BPEL process to + RiftSaw BPEL engine running within a JBoss AS server. + </para> + + </section> + + <section> + <title>Direct deployment to JBossAS server</title> + + <para> + The direct deployment approach is demonstrated using an <emphasis>Ant</emphasis> script + in each of the quickstart examples. For example, + </para> + + <informalexample> + <programlisting role="XML" ><![CDATA[ + <!-- Import the base Ant build script... --> + <property file="../../../install/deployment.properties" /> + + <property name="version" value="1" /> + + <property name="server.dir" value="${org.jboss.as.home}/server/${org.jboss.as.config}"/> + <property name="conf.dir" value="${server.dir}/conf"/> + <property name="deploy.dir" value="${server.dir}/deploy"/> + <property name="server.lib.dir" value="${server.dir}/lib"/> + + <property name="sample.jar.name" value="${ant.project.name}-${version}.jar" /> + + <target name="deploy"> + <echo>Deploy ${ant.project.name}</echo> + <jar basedir="bpel" destfile="${deploy.dir}/${sample.jar.name}" /> + </target> + + <target name="undeploy"> + <echo>Undeploy ${ant.project.name}</echo> + <delete file="${deploy.dir}/${sample.jar.name}" /> + </target> + ]]></programlisting> + </informalexample> + + <para> + This excerpt from the <emphasis>Ant</emphasis> build file for the <emphasis>hello_world</emphasis> + quickstart example shows that deploying a RiftSaw BPEL process using <emphasis>Ant</emphasis> + is very straightforward. The main points of interest are: + </para> + + <itemizedlist> + <listitem> + It is necessary to identify the location of the JBoss AS server in which + the BPEL process will be deployed. This is achieved in this example by + referring to the <filename>deployment.properties</filename> file that + has been configured in the RiftSaw distribution (install folder). + </listitem> + <listitem> + If a versioned approach is being used, so that multiple versions of the + same BPEL process may be deployed at one time, then the name of the + archive (jar) containing the BPEL process (and associated artifacts) + has a version number suffix. This would need to be manually incremented + for each distinct version of the BPEL process being deployed. + </listitem> + <listitem> + The next step is to define the <emphasis>deploy</emphasis> target, which + will create the BPEL process archive, using the contents of the bpel + sub-folder in this case, and store it within the JBoss AS + server's <filename>deploy</filename> folder. + </listitem> + <listitem> + The final step is to define the <emphasis>undeploy</emphasis> target, + which simply removes the BPEL process archive from the JBoss AS + server's <filename>deploy</filename> folder. + </listitem> + </itemizedlist> + + </section> + + <section> + <title>Eclipse based Deployment</title> + + <para> + This section will explain how to deploy an Eclipse BPEL project to the RiftSaw BPEL engine running + in a JBossAS server. + </para> + + <para> + The first step is to create or import the Eclipse BPEL project. In this case we are going to + import an existing project from the <filename>${RiftSaw}/samples/quickstart/hello_world</filename> + folder. This can be achieved by selecting the <emphasis>Import ...</emphasis> menu item associated + with the lefthand navigator panel in Eclipse, and then select the + <emphasis>General->Existing Projects into Workspace</emphasis> entry and press the + <emphasis>Next</emphasis> button. + </para> + + <imageobject> + <imagedata fileref="images/EclipseImportExistingProjectsIntoWorkspace.png" align="center" width="4in" /> + </imageobject> + + <para> + Then press the <emphasis>Browse</emphasis> button and navigate to the + <filename>hello_world</filename> quickstart folder. Once located, press the <emphasis>Finish</emphasis> + button. + </para> + + <imageobject> + <imagedata fileref="images/EclipseImportHelloWorld.png" align="center" width="4in" /> + </imageobject> + + <para> + Once the project has been imported, you can inspect the contents, such as the BPEL process + and WSDL description. + </para> + + <imageobject> + <imagedata fileref="images/EclipseHelloWorldProject.png" align="center" width="6in" /> + </imageobject> + + <para> + The next step is to create a server configuration for the JBoss AS environment in which the + RiftSaw BPEL engine has previously been installed. From the Eclipse <emphasis>Java EE</emphasis> + perspective, the <emphasis>Server</emphasis> tab should be visible in the lower region of the + Eclipse window. If this view is not present, then go to the + <emphasis>Window->Show Views->Servers</emphasis> menu item to open the view explicitly. + </para> + + <para> + In the <emphasis>Servers</emphasis> view, right click and select the <emphasis>New->Server</emphasis> + menu item. + </para> + + <imageobject> + <imagedata fileref="images/EclipseNewServer.png" align="center" width="4in" /> + </imageobject> + + <para> + Select the appropriate JBoss AS version, and then press <emphasis>Finish</emphasis>. + </para> + + <para> + Before being able to deploy an example, we should start the new server. This can be achieved + by right clicking on the server in the <emphasis>Servers</emphasis> tab, and selecting the + <emphasis>Start</emphasis> menu item. The output from the server will be displayed in the + <emphasis>Console</emphasis> tab. + </para> + + <para> + Once the server has been started, right click on the server entry again, and select the + <emphasis>Add and Remove ...</emphasis> menu item. + </para> + + <imageobject> + <imagedata fileref="images/EclipseAddRemoveProject.png" align="center" width="4in" /> + </imageobject> + + <para> + Select the <emphasis>Quickstart_bpel_hello_world</emphasis> project, press the + <emphasis>Add</emphasis> button and the press the <emphasis>Finish</emphasis> + button. This will cause the project to be deployed to the server. + </para> + + <imageobject> + <imagedata fileref="images/EclipseHelloWorldDeployed.png" align="center" width="3in" /> + </imageobject> + + <para> + Once the project has been deployed, it will show up as an entry below the server in the + <emphasis>Servers</emphasis> tab. + </para> + + <para> + The final step is to test the deployed BPEL process. In this example, we can do this + using the <emphasis>ant</emphasis> script provided with the quickstart sample. Right + click on the <filename>build.xml</filename> file in the root folder of the project, + and select the <emphasis>Run As->Ant Build ...</emphasis> menu item. NOTE: It is important + to select the menu item with the <emphasis>"..."</emphasis>, as this provides a dialog + window to enable you to select which <emphasis>ant target</emphasis> you wish to perform. + </para> + + <imageobject> + <imagedata fileref="images/EclipseSendHello.png" align="center" width="5in" /> + </imageobject> + + <para> + Deselect the <emphasis>deploy</emphasis> target, and select the <emphasis>sendhello</emphasis> + target, before pressing the <emphasis>Run</emphasis> button. This was send a test 'hello' + message to the server, and then display the response in the <emphasis>Console</emphasis> + tab. + </para> + + <imageobject> + <imagedata fileref="images/EclipseHelloWorldResponse.png" align="center" width="6in" /> + </imageobject> + + <para> + You can then use the menu associated with the project, contained in the server, to undeploy + the project (using the <emphasis>Add and Remove ...</emphasis> menu item) and finally use + the menu associated with the server itself to <emphasis>Stop</emphasis> the server. + </para> + </section> + +</chapter>