[jbpm-commits] JBoss JBPM SVN: r2287 - in jbpm4/pvm/trunk: modules/core/src/main/etc and 13 other directories.

Author: tom.baeyens(a)jboss.com Date: 2008-09-19 07:49:32 -0400 (Fri, 19 Sep 2008) New Revision: 2287 Added: jbpm4/pvm/trunk/modules/core/src/main/etc/distro/ jbpm4/pvm/trunk/modules/core/src/main/etc/distro/JBossORG-EULA.txt jbpm4/pvm/trunk/modules/core/src/main/etc/distro/lgpl.html jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example08/ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example08/DisplaySource.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example08/EventPropagationTest.java jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.automatic.wait1.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.automatic.wait2.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.automatic.wait3.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.concurrency.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/process.automatic.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/process.propagate.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/transactions.png Removed: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.wait1.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.wait2.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.wait3.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.concurrency.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/propagation.process.png Modified: jbpm4/pvm/trunk/assembly.xml jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example01/ObjectExecutionModeTest.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example02/PersistentExecutionModeTest.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example03/EmbeddedTests.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example04/DisplayActivityTest.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example04/TestConsole.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example05/ExternalActivityExampleTest.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example05/WaitState.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example06/BasicProcessExecutionTest.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example07/EventListenerTest.java jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example07/PrintLn.java jbpm4/pvm/trunk/modules/manual/src/main/diagrams/images.ppt jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch01-Introduction.xml jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch04-ImplementingBasicActivities.xml jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch05-ProcessAnatomy.xml jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch06-ImplementingAdvancedActivities.xml Log: docs Modified: jbpm4/pvm/trunk/assembly.xml =================================================================== --- jbpm4/pvm/trunk/assembly.xml 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/assembly.xml 2008-09-19 11:49:32 UTC (rev 2287) @@ -27,6 +27,10 @@ </moduleSets> <fileSets> <fileSet> + <directory>modules/core/src/main/etc/distro</directory> + <outputDirectory></outputDirectory> + </fileSet> + <fileSet> <directory>modules/core/target/apidocs</directory> <outputDirectory>doc/api</outputDirectory> </fileSet> Added: jbpm4/pvm/trunk/modules/core/src/main/etc/distro/JBossORG-EULA.txt =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/etc/distro/JBossORG-EULA.txt (rev 0) +++ jbpm4/pvm/trunk/modules/core/src/main/etc/distro/JBossORG-EULA.txt 2008-09-19 11:49:32 UTC (rev 2287) @@ -0,0 +1,104 @@ +LICENSE AGREEMENT +JBOSS(r) + +This License Agreement governs the use of the Software Packages and any updates to the Software +Packages, regardless of the delivery mechanism. Each Software Package is a collective work +under U.S. Copyright Law. Subject to the following terms, Red Hat, Inc. ("Red Hat") grants to +the user ("Client") a license to the applicable collective work(s) pursuant to the +GNU Lesser General Public License v. 2.1 except for the following Software Packages: +(a) JBoss Portal Forums and JBoss Transactions JTS, each of which is licensed pursuant to the +GNU General Public License v.2; + +(b) JBoss Rules, which is licensed pursuant to the Apache License v.2.0; + +(c) an optional download for JBoss Cache for the Berkeley DB for Java database, which is licensed under the +(open source) Sleepycat License (if Client does not wish to use the open source version of this database, +it may purchase a license from Sleepycat Software); + +and (d) the BPEL extension for JBoss jBPM, which is licensed under the Common Public License v.1, +and, pursuant to the OASIS BPEL4WS standard, requires parties wishing to redistribute to enter various +royalty-free patent licenses. + +Each of the foregoing licenses is available at http://www.opensource.org/licenses/index.php. + +1. The Software. "Software Packages" refer to the various software modules that are created and made available +for distribution by the JBoss.org open source community at http://www.jboss.org. Each of the Software Packages +may be comprised of hundreds of software components. The end user license agreement for each component is located in +the component's source code. With the exception of certain image files identified in Section 2 below, +the license terms for the components permit Client to copy, modify, and redistribute the component, +in both source code and binary code forms. This agreement does not limit Client's rights under, +or grant Client rights that supersede, the license terms of any particular component. + +2. Intellectual Property Rights. The Software Packages are owned by Red Hat and others and are protected under copyright +and other laws. Title to the Software Packages and any component, or to any copy, modification, or merged portion shall +remain with the aforementioned, subject to the applicable license. The "JBoss" trademark, "Red Hat" trademark, the +individual Software Package trademarks, and the "Shadowman" logo are registered trademarks of Red Hat and its affiliates +in the U.S. and other countries. This agreement permits Client to distribute unmodified copies of the Software Packages +using the Red Hat trademarks that Red Hat has inserted in the Software Packages on the condition that Client follows Red Hat's +trademark guidelines for those trademarks located at http://www.redhat.com/about/corporate/trademark/. Client must abide by +these trademark guidelines when distributing the Software Packages, regardless of whether the Software Packages have been modified. +If Client modifies the Software Packages, then Client must replace all Red Hat trademarks and logos identified at +http://www.jboss.com/company/logos unless a separate agreement with Red Hat is executed or other permission granted. +Merely deleting the files containing the Red Hat trademarks may corrupt the Software Packages. + +3. Limited Warranty. Except as specifically stated in this Paragraph 3 or a license for a particular +component, to the maximum extent permitted under applicable law, the Software Packages and the +components are provided and licensed "as is" without warranty of any kind, expressed or implied, +including the implied warranties of merchantability, non-infringement or fitness for a particular purpose. +Red Hat warrants that the media on which Software Packages may be furnished will be free from defects in +materials and manufacture under normal use for a period of 30 days from the date of delivery to Client. +Red Hat does not warrant that the functions contained in the Software Packages will meet Client's requirements +or that the operation of the Software Packages will be entirely error free or appear precisely as described +in the accompanying documentation. This warranty extends only to the party that purchases the Services +pertaining to the Software Packages from Red Hat or a Red Hat authorized distributor. + +4. Limitation of Remedies and Liability. To the maximum extent permitted by applicable law, the remedies +described below are accepted by Client as its only remedies. Red Hat's entire liability, and Client's +exclusive remedies, shall be: If the Software media is defective, Client may return it within 30 days of +delivery along with a copy of Client's payment receipt and Red Hat, at its option, will replace it or +refund the money paid by Client for the Software. To the maximum extent permitted by applicable law, +Red Hat or any Red Hat authorized dealer will not be liable to Client for any incidental or consequential +damages, including lost profits or lost savings arising out of the use or inability to use the Software, +even if Red Hat or such dealer has been advised of the possibility of such damages. In no event shall +Red Hat's liability under this agreement exceed the amount that Client paid to Red Hat under this +Agreement during the twelve months preceding the action. + +5. Export Control. As required by U.S. law, Client represents and warrants that it: +(a) understands that the Software Packages are subject to export controls under the +U.S. Commerce Department's Export Administration Regulations ("EAR"); + +(b) is not located in a prohibited destination country under the EAR or U.S. sanctions regulations +(currently Cuba, Iran, Iraq, Libya, North Korea, Sudan and Syria); + +(c) will not export, re-export, or transfer the Software Packages to any prohibited destination, entity, +or individual without the necessary export license(s) or authorizations(s) from the U.S. Government; + +(d) will not use or transfer the Software Packages for use in any sensitive nuclear, chemical or +biological weapons, or missile technology end-uses unless authorized by the U.S. Government by +regulation or specific license; + +(e) understands and agrees that if it is in the United States and exports or transfers the Software +Packages to eligible end users, it will, as required by EAR Section 740.17(e), submit semi-annual +reports to the Commerce Department's Bureau of Industry & Security (BIS), which include the name and +address (including country) of each transferee; + +and (f) understands that countries other than the United States may restrict the import, use, or +export of encryption products and that it shall be solely responsible for compliance with any such +import, use, or export restrictions. + +6. Third Party Programs. Red Hat may distribute third party software programs with the Software Packages +that are not part of the Software Packages and which Client must install separately. These third party +programs are subject to their own license terms. The license terms either accompany the programs or +can be viewed at http://www.redhat.com/licenses/. If Client does not agree to abide by the applicable +license terms for such programs, then Client may not install them. If Client wishes to install the programs +on more than one system or transfer the programs to another party, then Client must contact the licensor +of the programs. + +7. General. If any provision of this agreement is held to be unenforceable, that shall not affect the +enforceability of the remaining provisions. This License Agreement shall be governed by the laws of the +State of North Carolina and of the United States, without regard to any conflict of laws provisions, +except that the United Nations Convention on the International Sale of Goods shall not apply. + +Copyright 2006-2007 Red Hat, Inc. All rights reserved. +"JBoss" and the JBoss logo are registered trademarks of Red Hat, Inc. +All other trademarks are the property of their respective owners. Added: jbpm4/pvm/trunk/modules/core/src/main/etc/distro/lgpl.html =================================================================== --- jbpm4/pvm/trunk/modules/core/src/main/etc/distro/lgpl.html (rev 0) +++ jbpm4/pvm/trunk/modules/core/src/main/etc/distro/lgpl.html 2008-09-19 11:49:32 UTC (rev 2287) @@ -0,0 +1,350 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Appendix&nbsp;A.&nbsp;GNU Lesser General Public License</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1a"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="appendix" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="lgpl"></a>GNU Lesser General Public License</h1></div><div><p class="releaseinfo">This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.</p></div><div><p class="copyright">Copyright &copy; 1991, 1999 Free Software Foundation, Inc.</p></div><div><div class="legalnotice"><a name="gpl-legalnotice"></a><p> + </p><div class="address"><p>Free&nbsp;Software&nbsp;Foundation,&nbsp;Inc.<br> + &nbsp;&nbsp;<span class="street">51&nbsp;Franklin&nbsp;Street,&nbsp;Fifth&nbsp;Floor</span>,<br> + &nbsp;&nbsp;<span class="city">Boston</span>,<br> + &nbsp;&nbsp;<span class="state">MA</span><br> + &nbsp;&nbsp;<span class="postcode">02110-1301</span><br> + &nbsp;&nbsp;<span class="country">USA</span><br> + </p></div><p> + </p><p>Everyone is permitted to copy and distribute verbatim + copies of this license document, but changing it is not + allowed.</p></div></div><div><p class="pubdate">Version 2.1, February 1999</p></div></div></div> +<div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="lgpl-1"></a>Preamble</h2></div></div></div><p>The licenses for most software are designed to take away your + freedom to share and change it. By contrast, the GNU General Public + Licenses are intended to guarantee your freedom to share and change + free software--to make sure the software is free for all its users.</p><p>This license, the Lesser General Public License, applies to some + specially designated software packages--typically libraries--of the + Free Software Foundation and other authors who decide to use it. You + can use it too, but we suggest you first think carefully about whether + this license or the ordinary General Public License is the better + strategy to use in any particular case, based on the explanations below.</p><p>When we speak of free software, we are referring to freedom of use, + not price. Our General Public Licenses are designed to make sure that + you have the freedom to distribute copies of free software (and charge + for this service if you wish); that you receive source code or can get + it if you want it; that you can change the software and use pieces of + it in new free programs; and that you are informed that you can do + these things.</p><p>To protect your rights, we need to make restrictions that forbid + distributors to deny you these rights or to ask you to surrender these + rights. These restrictions translate to certain responsibilities for + you if you distribute copies of the library or if you modify it.</p><p>For example, if you distribute copies of the library, whether gratis + or for a fee, you must give the recipients all the rights that we gave + you. You must make sure that they, too, receive or can get the source + code. If you link other code with the library, you must provide + complete object files to the recipients, so that they can relink them + with the library after making changes to the library and recompiling + it. And you must show them these terms so they know their rights.</p><p>We protect your rights with a two-step method: + </p><div class="orderedlist"><ol type="1"><li><p>we copyright the library, and</p></li><li><p>we offer you this license, which gives you legal + permission to copy, distribute and/or modify the library.</p></li></ol></div><p> + </p><p>To protect each distributor, we want to make it very clear that + there is no warranty for the free library. Also, if the library is + modified by someone else and passed on, the recipients should know + that what they have is not the original version, so that the original + author's reputation will not be affected by problems that might be + introduced by others.</p><p>Finally, software patents pose a constant threat to the existence of + any free program. We wish to make sure that a company cannot + effectively restrict the users of a free program by obtaining a + restrictive license from a patent holder. Therefore, we insist that + any patent license obtained for a version of the library must be + consistent with the full freedom of use specified in this license.</p><p>Most GNU software, including some libraries, is covered by the + ordinary GNU General Public License. This license, the GNU Lesser + General Public License, applies to certain designated libraries, and + is quite different from the ordinary General Public License. We use + this license for certain libraries in order to permit linking those + libraries into non-free programs.</p><p>When a program is linked with a library, whether statically or using + a shared library, the combination of the two is legally speaking a + combined work, a derivative of the original library. The ordinary + General Public License therefore permits such linking only if the + entire combination fits its criteria of freedom. The Lesser General + Public License permits more lax criteria for linking other code with + the library.</p><p>We call this license the <span class="emphasis"><em>Lesser</em></span> General Public License because it + does Less to protect the user's freedom than the ordinary General + Public License. It also provides other free software developers Less + of an advantage over competing non-free programs. These disadvantages + are the reason we use the ordinary General Public License for many + libraries. However, the Lesser license provides advantages in certain + special circumstances.</p><p>For example, on rare occasions, there may be a special need to + encourage the widest possible use of a certain library, so that it becomes + a de-facto standard. To achieve this, non-free programs must be + allowed to use the library. A more frequent case is that a free + library does the same job as widely used non-free libraries. In this + case, there is little to gain by limiting the free library to free + software only, so we use the Lesser General Public License.</p><p>In other cases, permission to use a particular library in non-free + programs enables a greater number of people to use a large body of + free software. For example, permission to use the GNU C Library in + non-free programs enables many more people to use the whole GNU + operating system, as well as its variant, the GNU/Linux operating + system.</p><p>Although the Lesser General Public License is Less protective of the + users' freedom, it does ensure that the user of a program that is + linked with the Library has the freedom and the wherewithal to run + that program using a modified version of the Library.</p><p>The precise terms and conditions for copying, distribution and + modification follow. Pay close attention to the difference between a + &#8220;<span class="quote">work based on the library</span>&#8221; and a &#8220;<span class="quote">work that uses the library</span>&#8221;. The + former contains code derived from the library, whereas the latter must + be combined with the library in order to run.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="lgpl-2"></a>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-0"></a>Section 0</h3></div></div></div><p>This License Agreement applies to any software library or other + program which contains a notice placed by the copyright holder or + other authorized party saying it may be distributed under the terms of + this Lesser General Public License (also called &#8220;<span class="quote">this License</span>&#8221;). + Each licensee is addressed as &#8220;<span class="quote">you</span>&#8221;.</p><p>A &#8220;<span class="quote">library</span>&#8221; means a collection of software functions and/or data + prepared so as to be conveniently linked with application programs + (which use some of those functions and data) to form executables.</p><p>The &#8220;<span class="quote">Library</span>&#8221;, below, refers to any such software library or work + which has been distributed under these terms. A &#8220;<span class="quote">work based on the + Library</span>&#8221; means either the Library or any derivative work under + copyright law: that is to say, a work containing the Library or a + portion of it, either verbatim or with modifications and/or translated + straightforwardly into another language. (Hereinafter, translation is + included without limitation in the term &#8220;<span class="quote">modification</span>&#8221;.)</p><p>&#8220;<span class="quote">Source code</span>&#8221; for a work means the preferred form of the work for + making modifications to it. For a library, complete source code means + all the source code for all modules it contains, plus any associated + interface definition files, plus the scripts used to control compilation + and installation of the library.</p><p>Activities other than copying, distribution and modification are not + covered by this License; they are outside its scope. The act of + running a program using the Library is not restricted, and output from + such a program is covered only if its contents constitute a work based + on the Library (independent of the use of the Library in a tool for + writing it). Whether that is true depends on what the Library does + and what the program that uses the Library does.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-1"></a>Section 1</h3></div></div></div><p>You may copy and distribute verbatim copies of the Library's + complete source code as you receive it, in any medium, provided that + you conspicuously and appropriately publish on each copy an + appropriate copyright notice and disclaimer of warranty; keep intact + all the notices that refer to this License and to the absence of any + warranty; and distribute a copy of this License along with the + Library.</p><p>You may charge a fee for the physical act of transferring a copy, + and you may at your option offer warranty protection in exchange for a + fee.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-2"></a>Section 2</h3></div></div></div><p>You may modify your copy or copies of the Library or any portion + of it, thus forming a work based on the Library, and copy and + distribute such modifications or work under the terms of <a href="#lgpl-2-1" title="Section 1">Section 1</a> + above, provided that you also meet all of these conditions: + </p><div class="orderedlist"><ol type="a"><li><p>The modified work must itself be a software library.</p></li><li><p>You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change.</p></li><li><p>You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License.</p></li><li><p><a name="lgpl-2-2-d"></a>If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful.</p><p>(For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, <a href="#lgpl-2-2-d">Subsection 2d</a> requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.)</p></li></ol></div><p> + </p><p>These requirements apply to the modified work as a whole. If + identifiable sections of that work are not derived from the Library, + and can be reasonably considered independent and separate works in + themselves, then this License, and its terms, do not apply to those + sections when you distribute them as separate works. But when you + distribute the same sections as part of a whole which is a work based + on the Library, the distribution of the whole must be on the terms of + this License, whose permissions for other licensees extend to the + entire whole, and thus to each and every part regardless of who wrote + it.</p><p>Thus, it is not the intent of this section to claim rights or contest + your rights to work written entirely by you; rather, the intent is to + exercise the right to control the distribution of derivative or + collective works based on the Library.</p><p>In addition, mere aggregation of another work not based on the Library + with the Library (or with a work based on the Library) on a volume of + a storage or distribution medium does not bring the other work under + the scope of this License.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-3"></a>Section 3</h3></div></div></div><p>You may opt to apply the terms of the ordinary GNU General Public + License instead of this License to a given copy of the Library. To do + this, you must alter all the notices that refer to this License, so + that they refer to the ordinary GNU General Public License, version 2, + instead of to this License. (If a newer version than version 2 of the + ordinary GNU General Public License has appeared, then you can specify + that version instead if you wish.) Do not make any other change in + these notices.</p><p>Once this change is made in a given copy, it is irreversible for + that copy, so the ordinary GNU General Public License applies to all + subsequent copies and derivative works made from that copy.</p><p>This option is useful when you wish to copy part of the code of + the Library into a program that is not a library.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-4"></a>Section 4</h3></div></div></div><p>You may copy and distribute the Library (or a portion or + derivative of it, under <a href="#lgpl-2-2" title="Section 2">Section 2</a>) in object code or executable form + under the terms of <a href="#lgpl-2-1" title="Section 1">Sections 1</a> and <a href="#lgpl-2-2" title="Section 2">2</a> above provided that you accompany + it with the complete corresponding machine-readable source code, which + must be distributed under the terms of <a href="#lgpl-2-1" title="Section 1">Sections 1</a> and <a href="#lgpl-2-2" title="Section 2">2</a> above on a + medium customarily used for software interchange.</p><p>If distribution of object code is made by offering access to copy + from a designated place, then offering equivalent access to copy the + source code from the same place satisfies the requirement to + distribute the source code, even though third parties are not + compelled to copy the source along with the object code.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-5"></a>Section 5</h3></div></div></div><p>A program that contains no derivative of any portion of the + Library, but is designed to work with the Library by being compiled or + linked with it, is called a &#8220;<span class="quote">work that uses the Library</span>&#8221;. Such a + work, in isolation, is not a derivative work of the Library, and + therefore falls outside the scope of this License.</p><p>However, linking a &#8220;<span class="quote">work that uses the Library</span>&#8221; with the Library + creates an executable that is a derivative of the Library (because it + contains portions of the Library), rather than a &#8220;<span class="quote">work that uses the + library</span>&#8221;. The executable is therefore covered by this License. + <a href="#lgpl-2-6" title="Section 6">Section 6</a> states terms for distribution of such executables.</p><p>When a &#8220;<span class="quote">work that uses the Library</span>&#8221; uses material from a header file + that is part of the Library, the object code for the work may be a + derivative work of the Library even though the source code is not. + Whether this is true is especially significant if the work can be + linked without the Library, or if the work is itself a library. The + threshold for this to be true is not precisely defined by law.</p><p>If such an object file uses only numerical parameters, data + structure layouts and accessors, and small macros and small inline + functions (ten lines or less in length), then the use of the object + file is unrestricted, regardless of whether it is legally a derivative + work. (Executables containing this object code plus portions of the + Library will still fall under <a href="#lgpl-2-6" title="Section 6">Section 6</a>.)</p><p>Otherwise, if the work is a derivative of the Library, you may + distribute the object code for the work under the terms of <a href="#lgpl-2-6" title="Section 6">Section 6</a>. + Any executables containing that work also fall under <a href="#lgpl-2-6" title="Section 6">Section 6</a>, + whether or not they are linked directly with the Library itself.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-6"></a>Section 6</h3></div></div></div><p>As an exception to the Sections above, you may also combine or + link a &#8220;<span class="quote">work that uses the Library</span>&#8221; with the Library to produce a + work containing portions of the Library, and distribute that work + under terms of your choice, provided that the terms permit + modification of the work for the customer's own use and reverse + engineering for debugging such modifications.</p><p>You must give prominent notice with each copy of the work that the + Library is used in it and that the Library and its use are covered by + this License. You must supply a copy of this License. If the work + during execution displays copyright notices, you must include the + copyright notice for the Library among them, as well as a reference + directing the user to the copy of this License. Also, you must do one + of these things: + </p><div class="orderedlist"><ol type="a"><li><p><a name="lgpl-2-6-a"></a>Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + <a href="#lgpl-2-1" title="Section 1">Sections 1</a> and <a href="#lgpl-2-2" title="Section 2">2</a> above); and, if the work is an executable linked + with the Library, with the complete machine-readable &#8220;<span class="quote">work that + uses the Library</span>&#8221;, as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.)</p></li><li><p>Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with.</p></li><li><p>Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in <a href="#lgpl-2-6-a">Subsection 6a</a>, above, for a charge no more + than the cost of performing this distribution.</p></li><li><p>If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place.</p></li><li><p>Verify that the user has already received a copy of these + materials or that you have already sent this user a copy.</p></li></ol></div><p> + </p><p>For an executable, the required form of the &#8220;<span class="quote">work that uses the + Library</span>&#8221; must include any data and utility programs needed for + reproducing the executable from it. However, as a special exception, + the materials to be distributed need not include anything that is + normally distributed (in either source or binary form) with the major + components (compiler, kernel, and so on) of the operating system on + which the executable runs, unless that component itself accompanies + the executable.</p><p>It may happen that this requirement contradicts the license + restrictions of other proprietary libraries that do not normally + accompany the operating system. Such a contradiction means you cannot + use both them and the Library together in an executable that you + distribute.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-7"></a>Section 7</h3></div></div></div><p>You may place library facilities that are a work based on the + Library side-by-side in a single library together with other library + facilities not covered by this License, and distribute such a combined + library, provided that the separate distribution of the work based on + the Library and of the other library facilities is otherwise + permitted, and provided that you do these two things: + </p><div class="orderedlist"><ol type="a"><li><p>Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above.</p></li><li><p>Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work.</p></li></ol></div><p> + </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-8"></a>Section 8</h3></div></div></div><p>You may not copy, modify, sublicense, link with, or distribute + the Library except as expressly provided under this License. Any + attempt otherwise to copy, modify, sublicense, link with, or + distribute the Library is void, and will automatically terminate your + rights under this License. However, parties who have received copies, + or rights, from you under this License will not have their licenses + terminated so long as such parties remain in full compliance.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-9"></a>Section 9</h3></div></div></div><p>You are not required to accept this License, since you have not + signed it. However, nothing else grants you permission to modify or + distribute the Library or its derivative works. These actions are + prohibited by law if you do not accept this License. Therefore, by + modifying or distributing the Library (or any work based on the + Library), you indicate your acceptance of this License to do so, and + all its terms and conditions for copying, distributing or modifying + the Library or works based on it.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-10"></a>Section 10</h3></div></div></div><p>Each time you redistribute the Library (or any work based on the + Library), the recipient automatically receives a license from the + original licensor to copy, distribute, link with or modify the Library + subject to these terms and conditions. You may not impose any further + restrictions on the recipients' exercise of the rights granted herein. + You are not responsible for enforcing compliance by third parties with + this License.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-11"></a>Section 11</h3></div></div></div><p>If, as a consequence of a court judgment or allegation of patent + infringement or for any other reason (not limited to patent issues), + conditions are imposed on you (whether by court order, agreement or + otherwise) that contradict the conditions of this License, they do not + excuse you from the conditions of this License. If you cannot + distribute so as to satisfy simultaneously your obligations under this + License and any other pertinent obligations, then as a consequence you + may not distribute the Library at all. For example, if a patent + license would not permit royalty-free redistribution of the Library by + all those who receive copies directly or indirectly through you, then + the only way you could satisfy both it and this License would be to + refrain entirely from distribution of the Library.</p><p>If any portion of this section is held invalid or unenforceable under any + particular circumstance, the balance of the section is intended to apply, + and the section as a whole is intended to apply in other circumstances.</p><p>It is not the purpose of this section to induce you to infringe any + patents or other property right claims or to contest validity of any + such claims; this section has the sole purpose of protecting the + integrity of the free software distribution system which is + implemented by public license practices. Many people have made + generous contributions to the wide range of software distributed + through that system in reliance on consistent application of that + system; it is up to the author/donor to decide if he or she is willing + to distribute software through any other system and a licensee cannot + impose that choice.</p><p>This section is intended to make thoroughly clear what is believed to + be a consequence of the rest of this License.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-12"></a>Section 12</h3></div></div></div><p>If the distribution and/or use of the Library is restricted in + certain countries either by patents or by copyrighted interfaces, the + original copyright holder who places the Library under this License may add + an explicit geographical distribution limitation excluding those countries, + so that distribution is permitted only in or among countries not thus + excluded. In such case, this License incorporates the limitation as if + written in the body of this License.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-13"></a>Section 13</h3></div></div></div><p>The Free Software Foundation may publish revised and/or new + versions of the Lesser General Public License from time to time. + Such new versions will be similar in spirit to the present version, + but may differ in detail to address new problems or concerns.</p><p>Each version is given a distinguishing version number. If the Library + specifies a version number of this License which applies to it and + &#8220;<span class="quote">any later version</span>&#8221;, you have the option of following the terms and + conditions either of that version or of any later version published by + the Free Software Foundation. If the Library does not specify a + license version number, you may choose any version ever published by + the Free Software Foundation.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-14"></a>Section 14</h3></div></div></div><p>If you wish to incorporate parts of the Library into other free + programs whose distribution conditions are incompatible with these, + write to the author to ask for permission. For software which is + copyrighted by the Free Software Foundation, write to the Free + Software Foundation; we sometimes make exceptions for this. Our + decision will be guided by the two goals of preserving the free status + of all derivatives of our free software and of promoting the sharing + and reuse of software generally.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-15"></a>NO WARRANTY Section 15</h3></div></div></div><p>BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO + WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. + EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR + OTHER PARTIES PROVIDE THE LIBRARY &#8220;<span class="quote">AS IS</span>&#8221; WITHOUT WARRANTY OF ANY + KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE + LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME + THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="lgpl-2-16"></a>Section 16</h3></div></div></div><p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN + WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY + AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU + FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR + CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE + LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING + RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A + FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF + SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH + DAMAGES.</p><p>END OF TERMS AND CONDITIONS</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="lgpl-3"></a>How to Apply These Terms to Your New Libraries</h2></div></div></div><p>If you develop a new library, and you want it to be of the greatest + possible use to the public, we recommend making it free software that + everyone can redistribute and change. You can do so by permitting + redistribution under these terms (or, alternatively, under the terms of the + ordinary General Public License).</p><p>To apply these terms, attach the following notices to the library. It is + safest to attach them to the start of each source file to most effectively + convey the exclusion of warranty; and each file should have at least the + &#8220;<span class="quote">copyright</span>&#8221; line and a pointer to where the full notice is found.</p><p>&lt;one line to give the library's name and a brief idea of what it does.&gt; + Copyright (C) &lt;year&gt; &lt;name of author&gt;</p><p>This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version.</p><p>This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details.</p><p>You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</p><p>Also add information on how to contact you by electronic and paper mail.</p><p>You should also get your employer (if you work as a programmer) or your + school, if any, to sign a &#8220;<span class="quote">copyright disclaimer</span>&#8221; for the library, if + necessary. Here is a sample; alter the names:</p><p>Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker.</p><p>&lt;signature of Ty Coon&gt;, 1 April 1990 + Ty Coon, President of Vice</p><p>That's all there is to it!</p></div></div></body></html> Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example01/ObjectExecutionModeTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example01/ObjectExecutionModeTest.java 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example01/ObjectExecutionModeTest.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -1,3 +1,24 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ package org.jbpm.pvm.example01; import junit.framework.TestCase; Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example02/PersistentExecutionModeTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example02/PersistentExecutionModeTest.java 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example02/PersistentExecutionModeTest.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -1,3 +1,24 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ package org.jbpm.pvm.example02; import org.jbpm.pvm.Deployment; Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example03/EmbeddedTests.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example03/EmbeddedTests.java 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example03/EmbeddedTests.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -1,3 +1,24 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ package org.jbpm.pvm.example03; import junit.framework.Test; Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example04/DisplayActivityTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example04/DisplayActivityTest.java 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example04/DisplayActivityTest.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -1,3 +1,24 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ package org.jbpm.pvm.example04; import org.jbpm.pvm.Execution; Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example04/TestConsole.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example04/TestConsole.java 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example04/TestConsole.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -1,3 +1,24 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ package org.jbpm.pvm.example04; import java.io.PrintStream; Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example05/ExternalActivityExampleTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example05/ExternalActivityExampleTest.java 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example05/ExternalActivityExampleTest.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -1,3 +1,24 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ package org.jbpm.pvm.example05; import org.jbpm.pvm.client.ClientExecution; Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example05/WaitState.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example05/WaitState.java 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example05/WaitState.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -1,3 +1,24 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ package org.jbpm.pvm.example05; import java.util.Map; Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example06/BasicProcessExecutionTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example06/BasicProcessExecutionTest.java 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example06/BasicProcessExecutionTest.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -1,3 +1,24 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ package org.jbpm.pvm.example06; import org.jbpm.pvm.client.ClientExecution; Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example07/EventListenerTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example07/EventListenerTest.java 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example07/EventListenerTest.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -1,3 +1,24 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ package org.jbpm.pvm.example07; import javax.enterprise.deploy.spi.exceptions.ClientExecuteException; Modified: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example07/PrintLn.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example07/PrintLn.java 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example07/PrintLn.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -1,3 +1,24 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ package org.jbpm.pvm.example07; import org.jbpm.pvm.listener.EventListener; Added: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example08/DisplaySource.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example08/DisplaySource.java (rev 0) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example08/DisplaySource.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -0,0 +1,34 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jbpm.pvm.example08; + +import org.jbpm.pvm.listener.EventListener; +import org.jbpm.pvm.listener.EventListenerExecution; + +public class DisplaySource implements EventListener { + + private static final long serialVersionUID = 1L; + + public void notify(EventListenerExecution execution) { + System.out.println("leaving "+execution.getEventSource()); + } +} Added: jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example08/EventPropagationTest.java =================================================================== --- jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example08/EventPropagationTest.java (rev 0) +++ jbpm4/pvm/trunk/modules/core/src/test/java/org/jbpm/pvm/example08/EventPropagationTest.java 2008-09-19 11:49:32 UTC (rev 2287) @@ -0,0 +1,107 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY 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 along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jbpm.pvm.example08; + +import java.util.ArrayList; +import java.util.List; + +import org.jbpm.pvm.client.ClientExecution; +import org.jbpm.pvm.client.ClientProcessDefinition; +import org.jbpm.pvm.example01.WaitState; +import org.jbpm.pvm.example04.TestConsole; +import org.jbpm.pvm.model.Event; +import org.jbpm.pvm.model.ProcessFactory; +import org.jbpm.pvm.test.base.JbpmTestCase; + + +public class EventPropagationTest extends JbpmTestCase { + + TestConsole testConsole; + + public void setUp() { + testConsole = TestConsole.install(); + } + + public void tearDown() { + TestConsole.uninstall(); + testConsole = null; + } + + public void testEventPropagation() { + ClientProcessDefinition processDefinition = ProcessFactory.build("propagate") + .compositeNode("composite") + .event(Event.NODE_END) + .listener(new DisplaySource()) + .node("a").initial().behaviour(new WaitState()) + .transition().to("b") + .node("b").behaviour(new WaitState()) + .transition().to("c") + .compositeEnd() + .node("c").behaviour(new WaitState()) + .done(); + + ClientExecution execution = processDefinition.startProcessInstance(); + + List<String> expectedLines = new ArrayList<String>(); + assertEquals(expectedLines, testConsole.lines); + + execution.signal(); + + expectedLines.add("leaving node(a)"); + assertEquals(expectedLines, testConsole.lines); + + execution.signal(); + + expectedLines.add("leaving node(b)"); + expectedLines.add("leaving node(composite)"); + assertEquals(expectedLines, testConsole.lines); + } + + public void testEventPropagationDisabled() { + ClientProcessDefinition processDefinition = ProcessFactory.build("propagate") + .compositeNode("composite") + .event(Event.NODE_END) + .listener(new DisplaySource()) + .propagationDisabled() + .node("a").initial().behaviour(new WaitState()) + .transition().to("b") + .node("b").behaviour(new WaitState()) + .transition().to("c") + .compositeEnd() + .node("c").behaviour(new WaitState()) + .done(); + + ClientExecution execution = processDefinition.startProcessInstance(); + + List<String> expectedLines = new ArrayList<String>(); + assertEquals(expectedLines, testConsole.lines); + + execution.signal(); + + assertEquals(expectedLines, testConsole.lines); + + execution.signal(); + + expectedLines.add("leaving node(composite)"); + assertEquals(expectedLines, testConsole.lines); + } +} Modified: jbpm4/pvm/trunk/modules/manual/src/main/diagrams/images.ppt =================================================================== (Binary files differ) Deleted: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.png =================================================================== (Binary files differ) Deleted: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.wait1.png =================================================================== (Binary files differ) Deleted: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.wait2.png =================================================================== (Binary files differ) Deleted: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.wait3.png =================================================================== (Binary files differ) Deleted: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.concurrency.png =================================================================== (Binary files differ) Copied: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.automatic.wait1.png (from rev 2276, jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.wait1.png) =================================================================== (Binary files differ) Property changes on: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.automatic.wait1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Name: svn:mergeinfo + Copied: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.automatic.wait2.png (from rev 2276, jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.wait2.png) =================================================================== (Binary files differ) Property changes on: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.automatic.wait2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Name: svn:mergeinfo + Copied: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.automatic.wait3.png (from rev 2276, jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.wait3.png) =================================================================== (Binary files differ) Property changes on: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.automatic.wait3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Name: svn:mergeinfo + Copied: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.concurrency.png (from rev 2276, jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.concurrency.png) =================================================================== (Binary files differ) Property changes on: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/execution.concurrency.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Name: svn:mergeinfo + Copied: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/process.automatic.png (from rev 2276, jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/ch04.automatic.png) =================================================================== (Binary files differ) Property changes on: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/process.automatic.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Name: svn:mergeinfo + Copied: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/process.propagate.png (from rev 2276, jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/propagation.process.png) =================================================================== (Binary files differ) Property changes on: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/process.propagate.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Name: svn:mergeinfo + Deleted: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/propagation.process.png =================================================================== (Binary files differ) Added: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/transactions.png =================================================================== (Binary files differ) Property changes on: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/transactions.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch01-Introduction.xml =================================================================== --- jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch01-Introduction.xml 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch01-Introduction.xml 2008-09-19 11:49:32 UTC (rev 2287) @@ -2,6 +2,22 @@ <title>Introduction</title> <section> + <title>License and EULA</title> + <para>The Process Virtual Machine component is distributed under the terms of the + GNU Lesser General Public License (LGPL) and the JBoss End User License Agreement (EULA). + See <ulink url="lgpl.html">the full LGPL license text</ulink> and <ulink url="JBossORG-EULA.txt">the + full End User License Agreement</ulink>. + </para> + </section> + + <section> + <title>Sources</title> + <para>The source code for this component can be found in the jBPM SVN repository: + </para> + <ulink url="https://anonsvn.jboss.org/repos/jbpm/jbpm4/pvm/">https:... + </section> + + <section> <title>JVM version</title> <para>jbpm-pvm.jar requires a JVM version 5 or higher. </para> Modified: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch04-ImplementingBasicActivities.xml =================================================================== --- jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch04-ImplementingBasicActivities.xml 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch04-ImplementingBasicActivities.xml 2008-09-19 11:49:32 UTC (rev 2287) @@ -404,44 +404,44 @@ <para>Events are by default propagated to enclosing process elements. The motivation is to allow for listeners on process definitions or composite nodes that get executed for all events that occur within that process element. For example this feature - allows to register a listener on a process definition or a composite node on - <literal>node-leave</literal> events. Such action will be executed if that node is - left. And if that listener is registered on a composite node, it will also be executed + allows to register an event listener on a process definition or a composite node on + <literal>node-end</literal> events. Such action will be executed if that node is + left. And if that event listener is registered on a composite node, it will also be executed for all nodes that are left within that composite node. </para> - <para>To show this clearly, we'll create a <literal>DisplaySource</literal> activity + <para>To show this clearly, we'll create a <literal>DisplaySource</literal> event listener that will print the message <literal>leaving</literal> and the source of the event to the console. </para> - <programlisting>public class <emphasis role="bold">DisplaySource</emphasis> implements Activity { + <programlisting>public class <emphasis role="bold">DisplaySource</emphasis> implements EventListener { - public void execute(Execution execution) { + public void execute(EventListenerExecution execution) { <emphasis role="bold">System.out.println("leaving "+execution.getEventSource());</emphasis> } }</programlisting> - <para>Note that the purpose of event listeners is not to be visible, that's why the activity - itself should not be displayed in the diagram. A <literal>DisplaySource</literal> activity - will be added as a listener to the event <literal>node-leave</literal> on the composite node. + <para>Note that the purpose of event listeners is not to be visible, that's why the event listener + itself should not be displayed in the diagram. A <literal>DisplaySource</literal> event listener + will be added as a listener to the event <literal>node-end</literal> on the composite node. </para> - <para>The next process shows how the <literal>DisplaySource</literal> activity is registered - as a listener to to the 'node-leave' event on the <literal>composite</literal> node:</para> - <figure id="propagation.process"> - <title>A process with an invisible activity on a node-leave event on a composite node.</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/propagation.process.png"/></imageobject></mediaobject> + <para>The next process shows how the <literal>DisplaySource</literal> event listener is registered + as a listener to to the 'node-end' event on the <literal>composite</literal> node:</para> + <figure id="process.propagate"> + <title>A process with an invisible event listener on a node-end event on a composite node.</title> + <mediaobject><imageobject><imagedata align="center" fileref="images/process.propagate.png"/></imageobject></mediaobject> </figure> - <programlisting>ProcessDefinition processDefinition = ProcessFactory.build("propagate") - .compositeNode("composite") - <emphasis role="bold">.event(Node.EVENT_NODE_LEAVE) - .listener(new DisplaySource())</emphasis> - .node("a").initial().behaviour(new WaitState()) - .transition().to("b") - .node("b").behaviour(new WaitState()) - .transition().to("c") - .compositeEnd() - .node("c").behaviour(new WaitState()) + <programlisting>ClientProcessDefinition processDefinition = ProcessFactory.build("propagate") + <emphasis role="bold">.compositeNode("composite") + .event(Event.NODE_END) + .listener(new DisplaySource())</emphasis> + .node("a").initial().behaviour(new WaitState()) + .transition().to("b") + .node("b").behaviour(new WaitState()) + .transition().to("c") + .compositeEnd() + .node("c").behaviour(new WaitState()) .done();</programlisting> <para>Next we'll start an execution.</para> - <programlisting>Execution execution = processDefinition.startExecution();</programlisting> + <programlisting>ClientExecution execution = processDefinition.startProcessInstance();</programlisting> <para>After starting a new execution, the execution will be in node <literal>a</literal> as that is the initial node. No nodes have been left so no message is logged. Next a signal will be given to the execution, causing it to take the transition from <literal>a</literal> @@ -449,9 +449,12 @@ </para> <programlisting>execution.signal();</programlisting> <para>When the signal method returns, the execution will have taken the transition and - the node-leave event will be fired on node a. That event will be propagated to the - composite node and to the process definition. Since our propagation logger is placed - on node composite it will receive the event and print the following message: + the <literal>node-end</literal> event will be fired on node <literal>a</literal>. That + event will be propagated to the + composite node and to the process definition. Since our <literal>DisplaySource</literal> + event listener is placed + on the <literal>composite</literal> node, it will receive the event and print the following + message on the console: </para> <programlisting>leaving node(a)</programlisting> <para>Another</para> @@ -477,46 +480,54 @@ parent for it's source and destination. </para> <para>If an event listener is not interested in propagated events, propagation can be disabled - with <literal>propagationDisabled()</literal>. The next process is the same process + with <literal>propagationDisabled()</literal> while building the process with the + <literal>ProcessFactory</literal>. The next process is the same process as above except that propagated events will be disabled on the event listener. The graph diagram remains the same. </para> - <figure id="propagation.disabled.process"> - <title>A process with a listener to 'node-leave' events with propagation disabled.</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/propagation.process.png"/></imageobject></mediaobject> + <figure id="process.propagate.propagation.disabled"> + <title>A process with an event listener to 'node-end' events with propagation disabled.</title> + <mediaobject><imageobject><imagedata align="center" fileref="images/process.propagate.png"/></imageobject></mediaobject> </figure> <para>Building the process with the process factory: </para> - <programlisting>ProcessDefinition processDefinition = ProcessFactory.build("propagate") - .compositeNode("composite") - <emphasis role="bold">.event(Node.EVENT_NODE_LEAVE) - .listener(new DisplaySource()) - .propagationDisabled()</emphasis> - .node("a").initial().behaviour(new WaitState()) - .transition().to("b") - .node("b").behaviour(new WaitState()) - .transition().to("c") - .nodesEnd() - .node("c").behaviour(new WaitState()) + <programlisting>ClientProcessDefinition processDefinition = ProcessFactory.build("propagate") + .compositeNode("composite") + .event(Event.NODE_END) + .listener(new DisplaySource()) + <emphasis role="bold">.propagationDisabled()</emphasis> + .node("a").initial().behaviour(new WaitState()) + .transition().to("b") + .node("b").behaviour(new WaitState()) + .transition().to("c") + .compositeEnd() + .node("c").behaviour(new WaitState()) .done();</programlisting> - <para>So when the first signal is given for this process, again the node-leave event will be - fired on node a, but now the listener on the composite node will not be executed cause - propagated events have been disabled. Disabling propagation is a property on the listener - and doesn't influence the other listeners. The event will always be fired and propagated - over the whole parent hierarchy. + <para>So when the first signal is given for this process, again the <literal>node-end</literal> + event will be fired on node <literal>a</literal>, but now the event listener on the composite + node will not be executed cause + propagated events have been disabled. Disabling propagation is a property on the individual + event listener and doesn't influence the other listeners. The event will always be fired and + propagated over the whole parent hierarchy. </para> - <programlisting>Execution execution = processDefinition.startExecution(); -execution.signal(); -</programlisting> + <programlisting>ClientExecution execution = processDefinition.startProcessInstance();</programlisting> + <para>The first signal will take the process from <literal>a</literal> to + <literal>b</literal>. No messages will be printed to the console. + </para> + <programlisting>execution.signal();</programlisting> <para>Next, the second signal will take the transition from b to c. </para> <programlisting>execution.signal()</programlisting> - <para>Again two node-leave - events are fired just like above on nodes b and composite respectively. The first event - is the node-leave event on node b. That will be propagated to the composite node. So the + <para>Again two <literal>node-end</literal> + events are fired just like above on nodes <literal>b</literal> and <literal>composite</literal> + respectively. The first event + is the <literal>node-end</literal> event on node <literal>b</literal>. That will be propagated + to the <literal>composite</literal> node. So the event listener will not be executed for this event cause it has propagation disabled. But the - listener will be executed for the node-leave event on the composite node. That is not - propagated, but fired directly on the composite node. So the listener will now be executed + event listener will be executed for the <literal>node-end</literal> event on the + <literal>composite</literal> node. That is not + propagated, but fired directly on the <literal>composite</literal> node. So the event + listener will now be executed only once for the composite node as shown in the following console output: </para> <programlisting>leaving node(composite)</programlisting> Modified: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch05-ProcessAnatomy.xml =================================================================== --- jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch05-ProcessAnatomy.xml 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch05-ProcessAnatomy.xml 2008-09-19 11:49:32 UTC (rev 2287) @@ -18,7 +18,7 @@ <mediaobject><imageobject><imagedata align="center" fileref="images/process.anatomy.classes.png"/></imageobject></mediaobject> </figure> - <para>Next we'll describe a series of example diagram structures that can be formed + <para>Next we'll show a series of example diagram structures that can be formed with the PVM process model. </para> Modified: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch06-ImplementingAdvancedActivities.xml =================================================================== --- jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch06-ImplementingAdvancedActivities.xml 2008-09-19 10:34:35 UTC (rev 2286) +++ jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch06-ImplementingAdvancedActivities.xml 2008-09-19 11:49:32 UTC (rev 2287) @@ -4,16 +4,11 @@ <!-- ### LOOPS ########################################################## --> <section> <title>Loops</title> - <para>Loops can be based on transitions or on node composition. Loops can contain wait - states. + <para>Activities can implement loops based on transitions or on node composition. + Loops can contain wait states. </para> <para>To support high numbers of automatic loop executions, the Process Virtual Machine - tranformed the propagation of execution from tail recursion to a while loop. This means - that all the methods in the <literal>Execution</literal> class that propagate the - execution like <literal>take</literal> or <literal>execute</literal> will not be - executed when you call them. Instead, the method invocations will be appended to a list. - The first invocation of such a method will start a loop that will execute all invocations - till that list is empty. These invocations are called atomic operations. + tranformed the propagation of execution from tail recursion to a while loop. </para> </section> @@ -72,6 +67,14 @@ ...do functional work... } }</programlisting> + <para>The <literal>perform</literal> method takes an <literal>OpenExecution</literal>, + which is the supertype of both <literal>ActivityExecution</literal> and + <literal>EventListenerExecution</literal>. <literal>OpenExecution</literal> + does not allow any of the specific purpose methods, but still + the current state and the process definition can be inspected as well + as the variables, which contain the context information for the process + execution. + </para> <para>None of these methods actually invoke execution propagation methods. So after the perform method is completed, the execution will <link linkend="implicitproceedbehaviour">proceed in the default way</link>. @@ -97,12 +100,12 @@ <para>The next process will show the basics concretely. It has three wait states and four automatic nodes. </para> - <figure id="automatic"> + <figure id="process.automatic"> <title>Process with many sequential automatic activities.</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/ch04.automatic.png"/></imageobject></mediaobject> + <mediaobject><imageobject><imagedata align="center" fileref="images/process.automatic.png"/></imageobject></mediaobject> </figure> <para>Here's how to build the process:</para> - <programlisting>ProcessDefinition processDefinition = ProcessFactory.build("automatic") + <programlisting>ClientProcessDefinition processDefinition = ProcessFactory.build("automatic") .<emphasis role="bold">node("wait 1").initial()</emphasis>.behaviour(new <emphasis role="bold">WaitState</emphasis>()) .transition().to("automatic 1") .<emphasis role="bold">node("automatic 1")</emphasis>.behaviour(new <emphasis role="bold">Display("one")</emphasis>) @@ -119,48 +122,105 @@ .done();</programlisting> <para>Let's walk you through one execution of this process. </para> - <programlisting>Execution execution = processDefinition.startExecution();</programlisting> + <programlisting>ClientExecution execution = processDefinition.startProcessInstance();</programlisting> <para>Starting a new execution means that the initial node is executed. So if an automatic - activity would be configured as the behaviour in the initial node, the process will start executing - immediatly in the startExecution. In this case however, the initial node is a wait state. So - the startExecution method returns immediately and the execution will be positioned in the initial - node 'wait 1'. + activity is the initial node, this means that immediately the first unnamed outgoing transition + is taken. This happens all inside of the invocation of <literal>startProcessInstance</literal>. </para> - <figure id="automatic.wait1"> + <para>In this case however, the initial node is a wait state. So + the method <literal>startProcessInstance</literal> returns immediately and the execution will be + positioned in the initial node 'wait 1'. + </para> + <figure id="execution.automatic.wait1"> <title>A new execution will be positioned in 'wait 1'.</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/ch04.automatic.wait1.png"/></imageobject></mediaobject> + <mediaobject><imageobject><imagedata align="center" fileref="images/execution.automatic.wait1.png"/></imageobject></mediaobject> </figure> <para>Then an external trigger is given with the signal method.</para> <programlisting>execution.signal();</programlisting> - <para>As explained above when introducing the WaitState, that signal will cause the default transition to be taken. The - transition will move the execution to node <literal>automatic 1</literal> and execute it. The execute method - of the <literal>Display</literal> activity in <literal>automatic 1</literal> print a line to the console and it - will <emphasis role="bold">not</emphasis> call <literal>execution.waitForSignal()</literal>. Therefore, the execution - will proceed by taking the default transition out of <literal>automatic 1</literal>. The signal method is still blocking - cause this action and the transitions are taken - by that same thread. Then the execution arrives in <literal>wait 2</literal> and executes the <literal>WaitState</literal> - activity. That method will invoke the <literal>execution.waitForSignal()</literal>, which will cause the signal method - to return. That is when the thread is given back to the client that invoked the signal method. + <para>As explained above when <link linkend="externalactivityexample">introducing the WaitState</link>, + that signal will cause the default transition to be taken. The + transition will move the execution to node <literal>automatic 1</literal> and execute it. + The execute method of the <literal>Display</literal> activity in <literal>automatic 1</literal> + print a line to the console and it will <emphasis role="bold">not</emphasis> call + <literal>execution.waitForSignal()</literal>. Therefore, the execution will proceed by + taking the default transition out of <literal>automatic 1</literal>. At this stage, the + signal method is still blocking. Another way to think about it is that the execution + methods like <literal>signal</literal> will use the thread of the client to interpret + the process definition until a wait state is reached. </para> + <para>Then the execution arrives in <literal>wait 2</literal> and executes + the <literal>WaitState</literal> activity. That method will invoke + the <literal>execution.waitForSignal()</literal>, which will cause the signal method + to return. That is when the thread is given back to the client that invoked the + <literal>signal</literal> method. + </para> <para>So when the signal method returns, the execution is positioned in <literal>wait 2</literal>.</para> - <figure id="automatic.wait2"> + <figure id="execution.automatic.wait2"> <title>One signal brought the execution from 'initial' to 'wait 2'.</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/ch04.automatic.wait2.png"/></imageobject></mediaobject> + <mediaobject><imageobject><imagedata align="center" fileref="images/execution.automatic.wait2.png"/></imageobject></mediaobject> </figure> - <para>Then the execution is now waiting for an external trigger just as an object (more precisely an object graph) in - memory until the next external trigger is given with the signal method. + <para>Then the execution is now waiting for an external trigger just as an object + (more precisely an object graph) in memory until the next external trigger is given + with the signal method. </para> <programlisting>execution.signal();</programlisting> - <para>This second invocation of signal will take the execution similarly all the way to <literal>wait 3</literal> before - it returns. + <para>This second invocation of signal will take the execution similarly all the + way to <literal>wait 3</literal> before it returns. </para> <figure id="automatic.wait3"> <title>The second signal brought the execution all the way to 'wait 3'.</title> <mediaobject><imageobject><imagedata align="center" fileref="images/ch04.automatic.wait3.png"/></imageobject></mediaobject> </figure> - <para>To make executable processes, developers need to know exactly what the automatic activities, - what the wait states are and which threads will be allocated to the process execution. For business - analysts that draw the analysis process, things are a bit simpler. For the + <para>The benefits of using this paradigm is that the same process definition + can be executed in <link linkend="clientexecutionmode">client execution mode</link> + (in-memory without persistence) as well as in <link linkend="persistentexecutionmode"> + persistent execution mode</link>, depending on the application and on the environment. + </para> + <para>When executing a process in persistent mode, this is how you typically want + to bind that process execution to transactions of the database: + </para> + <figure id="transactions.png"> + <title>Transactions over time in persistent execution mode.</title> + <mediaobject><imageobject><imagedata align="center" fileref="images/transactions.png"/></imageobject></mediaobject> + </figure> + <para>In most situations, the computational work that needs to be done as part of + the process after an external trigger (the red pieces) is pretty minimal. Typically + transactions combining the process execution and processing the request from the + UI takes typically less then a second. Whereas the wait state in business processes + typically can span for hours, days or even years. The clue is to clearly distinct + when a wait state starts so that only the computational work done before the start + of that wait state should be included in the transaction. + </para> + <para>Think of + it this way: &quot;When an approval arrives, what are all the automated processing that + needs to be done before the process system needs to wait for another external + trigger?&quot; Unless pdf's need to be generated or mass emails need to be send, + the amount of time that this takes is usually neglectable. That is why in the + default persistent execution mode, the process work is executed in the thread + of the client. + </para> + <para>This reasoning even holds in case of concurrent paths of execution. + When a single path of execution splits into concurrent paths of execution, + the process overhead of calculating that is neglectable. So that is why it + makes sense for a fork or split activity implementation that targets persistent + execution mode to spawn the concurrent paths sequentially in the same thread. + Basically it's all just computational work as part of the same transaction. + This can only be done because the fork/split knows that each concurrent path + of execution will return whenever a wait state is encountered. + </para> + <para>Since this is a difficult concept to grasp, I'll explain it again with other + words. Look at it from the overhead that is produced by the process execution + itself in persistent execution mode. If in a transaction, an execution is given + an external trigger and that causes the execution to split into multiple concurrent + paths of execution. Then the process overhead of calculating this is neglectable. + Also the overhead of the generated SQL is neglectable. And since all the work done + in the concurrent branches must be done inside that single transaction, there is + typically no point in having fork/split implementations spawn the concurrent + paths of execution in multiple threads. + </para> + <para>To make executable processes, developers need to know exactly what the automatic activities + are, what the wait states are and which threads will be allocated to the process execution. + For business analysts that draw the analysis process, things are a bit simpler. For the activities they draw, they usually know whether it's a human or a system that is responsible. But they typically don't not how this translates to threads and transactions. </para> @@ -176,17 +236,25 @@ <title>Process concurrency</title> <para>To model process concurrency, there is a parent-child tree structure on the execution. The idea is that the main path of execution is the root of that tree. - This implies that on the level of the Process Virtual Machine, there is no differentiation - between complete process instances and paths of execution within a process instance. - One of the main motivations for this design is that the API actually is not made more - complex then necessary for simple processes with only one single path of execution. + The main path of execution is also called the process instance. It is the execution + that is created when starting or creating a new process instance for a given + process definition. </para> + <para>Now, because the main path of execution is the same object as the + process instance, this keeps the usage simple in case of simple processes + without concurrency. + </para> <figure id="execution.structure"> <title>UML class diagram of the basic execution structure</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/ch04.execution.structure.classes.png"/></imageobject></mediaobject> + <mediaobject><imageobject><imagedata align="center" fileref="images/class.diagram.process.execution.png"/></imageobject></mediaobject> </figure> - <para>To extablish multiple concurrent paths of execution, child executions can be - created. Only leaf executions can be active. Non-leave executions should be + <para>To establish multiple concurrent paths of execution, activity implementations + like a fork or split can create child executions with method + <literal>ActivityExecution.createExecution</literal>. Activity implementations + like join or merge can stop these concurrent paths of execution by calling + method <literal>stop</literal> on the concurrent execution. + </para> + <para>Only leaf executions can be active. Non-leave executions should be inactive. This tree structure of executions doesn't enforce a particular type of concurrency or join behaviour. It's up to the forks or and-splits and to the joins or and-merges to use the execution tree structure in any way they want to define @@ -195,7 +263,7 @@ </para> <figure id="concurrency"> <title>Concurrent paths of execution</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/ch04.concurrency.png"/></imageobject></mediaobject> + <mediaobject><imageobject><imagedata align="center" fileref="images/execution.concurrency.png"/></imageobject></mediaobject> </figure> <para>There is a billing and a shipping path of execution. In this case, the flat bar nodes represent nodes that fork and join. The execution shows a three @@ -216,9 +284,11 @@ <!-- ### EXCEPTION HANDLERS ############################################# --> <section> <title>Exception handlers</title> - <para>In all the <link linkend="delegationclasses">code that is associated to a process</link> - like Activity's, Actions and Conditions, it's possible to include try-catch blocks in - the method implementations to handle exceptions. But in order to build more reusable building + <para>In all the code that is associated to a process + like <literal>Activity</literal>s, <literal>EventListeners</literal> and + <literal>Condition</literal>s, it's possible to associate exception handlers. This + can be thought of as including try-catch blocks in + the method implementations of those implementations. But in order to build more reusable building blocks for both the delegation classes and the exception handling logic, exception handlers are added to the core process model. </para> @@ -258,8 +328,8 @@ <title>Locking and execution state</title> <para>The state of an execution is either active or locked. An active execution is either executing or waiting for an external trigger. If an - execution is not in STATE_ACTIVE, then it is locked. A locked execution - is read only. + execution is not in <literal>STATE_ACTIVE</literal>, then it is locked. + A locked execution is read only and cannot receive any external triggers. </para> <para>When a new execution is created, it is in STATE_ACTIVE. To change the state to a locked state, use lock(String). Some STATE_* constants