Author: buildbot
Date: Fri Dec 28 13:34:15 2012
New Revision: 844119
Log:
Staging update by buildbot for ode
Modified:
websites/staging/ode/trunk/content/ (props changed)
websites/staging/ode/trunk/content/management-api.html
Propchange: websites/staging/ode/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Dec 28 13:34:15 2012
@@ -1 +1 @@
-1426508
+1426510
Modified: websites/staging/ode/trunk/content/management-api.html
==============================================================================
--- websites/staging/ode/trunk/content/management-api.html (original)
+++ websites/staging/ode/trunk/content/management-api.html Fri Dec 28 13:34:15
2012
@@ -86,11 +86,13 @@
<h2 id="overview">Overview</h2>
<p>ODE has a complete management API to check which processes are deployed,
running and completed instances, variables values and more. To see which
methods are available, have a look at the <a
href="http://ode.apache.org/javadoc/org/apache/ode/bpel/pmapi/ProcessManagement.html";>ProcessManagement</a>
and <a
href="http://ode.apache.org/javadoc/org/apache/ode/bpel/pmapi/InstanceManagement.html";>InstanceManagement</a>
interfaces, the javadoc is pretty comprehensive.</p>
<p>These two interfaces are available as web services on the Axis2-based
distribution. The corresponding WSDL can be found <a
href="http://svn.apache.org/repos/asf/ode/trunk/axis2/src/main/wsdl/pmapi.wsdl";>here</a>.</p>
-<p>To invoke these two services, any web service client should work (in a
perfect interoperable world). To ease the invocation when using an Axis2
client, a helper class is bundled in ode-axis2.jar: <a
href="http://ode.apache.org/javadoc/axis2/org/apache/ode/axis2/service/ServiceClientUtil.html";>ServiceClientUtil</a>.
Usage examples are also available in test classes <a
href="http://svn.apache.org/repos/asf/ode/trunk/axis2/src/test/java/org/apache/ode/axis2/management/InstanceManagementTest.java";>InstanceManagementTest</a>
and <a
href="http://svn.apache.org/repos/asf/ode/trunk/axis2/src/test/java/org/apache/ode/axis2/management/ProcessManagementTest.java";>ProcessManagementTest</a>.
Here is a short example demonstrating the invocation of the
<em>listAllProcesses</em> operation:
- :::java
- ServiceClientUtil client = new ServiceClientUtil();
- OMElement root = client.buildMessage("listAllProcesses", new String<a
href=".html"></a> {}, new String[] {});
- OMElement result = client.send(msg,
"http://localhost:8080/ode/processes/ProcessManagement";);</p>
+<p>To invoke these two services, any web service client should work (in a
perfect interoperable world). To ease the invocation when using an Axis2
client, a helper class is bundled in ode-axis2.jar: <a
href="http://ode.apache.org/javadoc/axis2/org/apache/ode/axis2/service/ServiceClientUtil.html";>ServiceClientUtil</a>.
Usage examples are also available in test classes <a
href="http://svn.apache.org/repos/asf/ode/trunk/axis2/src/test/java/org/apache/ode/axis2/management/InstanceManagementTest.java";>InstanceManagementTest</a>
and <a
href="http://svn.apache.org/repos/asf/ode/trunk/axis2/src/test/java/org/apache/ode/axis2/management/ProcessManagementTest.java";>ProcessManagementTest</a>.
Here is a short example demonstrating the invocation of the
<em>listAllProcesses</em> operation:</p>
+<div class="codehilite"><pre><span class="n">ServiceClientUtil</span> <span
class="n">client</span> <span class="o">=</span> <span class="k">new</span>
<span class="n">ServiceClientUtil</span><span class="o">();</span>
+<span class="n">OMElement</span> <span class="n">root</span> <span
class="o">=</span> <span class="n">client</span><span class="o">.</span><span
class="na">buildMessage</span><span class="o">(</span><span
class="s">"listAllProcesses"</span><span class="o">,</span> <span
class="k">new</span> <span class="n">String</span><span class="o">[]</span>
<span class="o">{},</span> <span class="k">new</span> <span
class="n">String</span><span class="o">[]</span> <span class="o">{});</span>
+<span class="n">OMElement</span> <span class="n">result</span> <span
class="o">=</span> <span class="n">client</span><span class="o">.</span><span
class="na">send</span><span class="o">(</span><span class="n">msg</span><span
class="o">,</span> <span
class="s">"http://localhost:8080/ode/processes/ProcessManagement"</span><span
class="o">);</span>
+</pre></div>
+
+
<p>We're using <a href="http://xmlbeans.apache.org/";>XMLBeans</a> to serialize
and deserialize the returned values from/to XML so in the previous example. So
if you'd like to have objects instead of an <a
href="http://ws.apache.org/commons/axiom/index.html";>Axiom</a> structure in the
previous example, just add the following lines of code:</p>
<div class="codehilite"><pre><span class="n">ScopeInfoDocument</span> <span
class="n">scopeIndoDoc</span> <span class="o">=</span> <span
class="n">ScopeInfoDocument</span><span class="o">.</span><span
class="na">Factory</span><span class="o">.</span><span
class="na">parse</span><span class="o">(</span><span
class="n">result</span><span class="o">.</span><span
class="na">getXMLStreamReader</span><span class="o">());</span>
</pre></div>
