You are viewing a plain text version of this content. The canonical link for it is here.
Posted to muse-dev@ws.apache.org by ip...@apache.org on 2004/11/29 20:47:02 UTC
svn commit: r106944 - /incubator/muse/trunk/src/site/content/xdocs/tutorial/probe/index.xml
Author: ips
Date: Mon Nov 29 11:47:01 2004
New Revision: 106944
URL: http://svn.apache.org/viewcvs?view=rev&rev=106944
Log:
.
Modified:
incubator/muse/trunk/src/site/content/xdocs/tutorial/probe/index.xml
Modified: incubator/muse/trunk/src/site/content/xdocs/tutorial/probe/index.xml
Url: http://svn.apache.org/viewcvs/incubator/muse/trunk/src/site/content/xdocs/tutorial/probe/index.xml?view=diff&rev=106944&p1=incubator/muse/trunk/src/site/content/xdocs/tutorial/probe/index.xml&r1=106943&p2=incubator/muse/trunk/src/site/content/xdocs/tutorial/probe/index.xml&r2=106944
==============================================================================
--- incubator/muse/trunk/src/site/content/xdocs/tutorial/probe/index.xml (original)
+++ incubator/muse/trunk/src/site/content/xdocs/tutorial/probe/index.xml Mon Nov 29 11:47:01 2004
@@ -4,14 +4,160 @@
<document>
<header>
- <title>Muse Manual</title>
+ <title>Muse Tutorial: A More Complex Example</title>
</header>
- <body>
- <section>
- <title>Muse Manual</title>
- <p>
- TODO
+ <body>
+
+ <section>
+ <title>Introduction</title>
+
+ <p>The Mt. Laurel Jet Propulsion Lab has successfully launched a Mercury
+ Probe and it is currently on the surface of Mercury performing scientific
+ research. The Mercury Probe has 4 temperature sensors, one forward, one in
+ the rear, one on the left and one on the right. A temperature sensor
+ probes the Mercury atmosphere periodically and reports the results back to
+ Mt. Laurel Ground Control (temperatures range from 100 degrees Kelvin to
+ 700K - which is -280F to 427F). At Ground Control, the sensor readings are
+ examined. Should sensors detect a high temperature (say above 400K),
+ Ground Control will issue commands to turn on the AC unit on the probe to
+ help cool it off. When the temperature then goes below that level,
+ Ground Control will issue commands to the probe to turn off the AC unit.
+ To help facilitate scientific research, Ground Control will publish its
+ temperature readings on the Internet. A web service will provide metric
+ data to the scientific community, including the average temperature, the
+ highest temperature reading encountered, the lowest temperature reading
+ encountered, and the like.</p>
+
+ <section>
+ <title><a href="src/generated-override/axis/com/probe/service/sensor/SensorWsdmServiceWSResource.java">Sensor Service</a> (<a href="src/wsdl/sensor.wsdl">wsdl</a>)</title>
+ <p>This service has one custom resource property called "temperature". It
+ is a gauge metric whose time scope is PointInTime. It supports MUWS so it
+ has a Start and Stop operation. When started, it emits a temperature
+ notification every X seconds. That notification is a resource
+ property change notification, emitted when the temperature resource
+ property changes (which occurs when the temperature gauge takes a new
+ reading).</p>
+ <p>The temperature readings follow a sine wave, with the minimum
+ temperature being 100 and maximum temperature being 700, following the
+ pattern of the rotation of the planet Mercury.</p>
+ </section>
+
+ <section>
+ <title>
+ <a href="src/generated-override/axis/com/probe/service/ac/ACSystemWsdmServiceWSResource.java">AC System Service</a> (<a href="src/wsdl/ac.wsdl">WSDL</a>)</title>
+ <p>The Air Conditioning System service is a notification consumer of
+ <a href="#SensorService">Sensor Service</a>
+ notifications. It listens for temperature readings and when it sees temperatures reach a certain level, it turns the AC on by sending the proper commands to
+ the Mercury probe. When the temperatures go lower, below the level where AC is
+ required, this service sends the proper commands to the probe to turn off the AC. This
+ service has a "state" resource property that says whether the AC is ON or
+ OFF. There is a resource property change notification emitted when
+ this service's state
+ changes. This also has a MUWS Start and Stop that allows a client to tell the AC
+ service to start (or stop) listening to sensor temperature readings.</p>
+ </section>
+
+ <section>
+ <title><a href="src/generated-override/axis/com/probe/service/report/ReportWsdmServiceWSResource.java">Report Service</a> (<a href="src/wsdl/report.wsdl">WSDL</a>)</title>
+ <p>This service is provided to the scientific community. It has several metric properties that are collected in a cyclical
+ fashion and published:</p>
+ <ul>
+ <li>Average Temperature</li>
+ <li>Maximum Temperature</li>
+ <li>Minimum Temperature</li>
+ <li>Temperature Data Points</li>
+ </ul>
+ <p>Note
+ that this service will illustrate a very simple service with no support for WS-ResourceLifetime or
+ WS-Notifications.</p>
+ </section>
+
+ <section>
+ <title><a href="src/java/com/probe/ProbeDiscoveryAgent.java">Discovery</a></title>
+ <p>The Probe discovery agent needs to create 4 instances of the temperature sensor
+ service (one for each sensor on the probe). The discovery will also
+ create one AC System Service and one Report service - each of which are singletons.
+ There is a very simple <a href="src/webapp/discovery-agent-registry.xml">
+ configuration file</a> for this Probe discovery agent.</p>
+ </section>
+
+ <section>
+ <title><a href="src/java/com/probe/client/CommandLineClient.java">Command Line Client</a></title>
+ <p>A command line client is provided that offers a menu of items used to act as a
+ client to the Probe services. Starting and stopping the services and examining the
+ data exposed by the services are provided by the command line client.</p>
+ </section>
+
+ </section>
+
+ <section>
+
+ <title>Procedural Overview</title>
+ <p>
+ In order to start working with the Mercury Probe Example:</p>
+ <ol>
+ <li>Install J-MUWS distribution</li>
+ <li>Build the Mercury Probe example services and associated Java
+ objects using the Ant script</li>
+ <li>Deploy the webapp produced by the build scripts to Tomcat or another servlet container</li>
+ <li>Start the servlet container.</li>
+ <li>Run the command line client program to interact with the Probe services</li>
+ </ol>
+ <p>These procedural steps are fully explained in the following sections:</p>
+
+ <section>
+ <title>Install J-MUWS distribution</title>
+ <p>Simply unzip the J-MUWS distribution into a local directory. Make sure
+ JDK 1.4, Apache Ant 1.5+, and a servlet container (such as Tomcat)
+ are installed. </p>
+ </section>
+
+ <section>
+ <title>Build Example Services using Ant</title>
+ <p>Go to the installation's <code>example/probe</code>
+ directory and run <code>ant all </code>. This will
+ generate all code based on the example WSDL documents, compile all code
+ and deploy the example to the wsdm webapp (<code>webapps/wsdm</code>).
</p>
+ </section>
+
+ <section>
+ <title>Deploy webapp</title>
+ <p>Deploy the wsdm webapp to your servlet container. For
+ Tomcat, if Tomcat is set to development mode, simply copy the wsdm directory
+ into Tomcat's <code>webapps</code> directory.</p>
+ </section>
+
+ <section>
+ <title>Run SOAP engine</title>
+ <p>To start the services, you must now start your servlet container. For
+ Tomcat, simply run (<code>bin/startup.bat</code>.</p>
+ </section>
+
+ <section>
+ <title>Run the Command Line Client</title>
+ <p>To begin interacting with the Probe services, you must start the
+ Command Line Client. Start the Java class
+ <a href="src/java/com/probe/client/CommandLineClient.java">
+ CommandLineClient</a> which has a main that can be used to start it as a
+ Java application (there is a convenience batch <a href="probeclient.bat">probeclient.bat
+ </a>file to do this for you). Upon startup, you will be shown a menu of items
+ you can select. You should choose to start the AC service and reset
+ the Report service, then start the Sensor services (the order is not
+ important). You can then choose other menu items that collect
+ information from the services and display them to the console.</p>
+ </section>
+
+ </section>
+
+ <section>
+
+ <title>Next Steps</title>
+ <p>To start developing your own J-MuWS services visit the
+ <a href="../template/index.html"> Starting Templates</a>.</p>
+
</section>
+
</body>
+
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: muse-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: muse-dev-help@ws.apache.org