You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by an...@apache.org on 2006/05/16 18:50:41 UTC

svn commit: r406987 - in /incubator/tuscany/java/samples/sca: customerinfo/readme.htm readme.htm

Author: antelder
Date: Tue May 16 09:50:39 2006
New Revision: 406987

URL: http://svn.apache.org/viewcvs?rev=406987&view=rev
Log:
add customerinfo sample readme

Added:
    incubator/tuscany/java/samples/sca/customerinfo/readme.htm
Modified:
    incubator/tuscany/java/samples/sca/readme.htm

Added: incubator/tuscany/java/samples/sca/customerinfo/readme.htm
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/samples/sca/customerinfo/readme.htm?rev=406987&view=auto
==============================================================================
--- incubator/tuscany/java/samples/sca/customerinfo/readme.htm (added)
+++ incubator/tuscany/java/samples/sca/customerinfo/readme.htm Tue May 16 09:50:39 2006
@@ -0,0 +1,61 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><!-- Copyright (c) 2005 The Apache Software Foundation or its licensors, as applicable. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Style-Type" content="text/css"><title>Tuscany
+CustomerInfo </title><!-- LINK rel="stylesheet" href="ait.css" type="text/css" -->
+<style type="text/css" media="all">
+@import url("../../../../css/maven-base.css");
+@import url("../../../../css/maven-theme.css");
+@import url("../../../../css/site.css");
+</style><link rel="stylesheet" href="./css/print.css" type="text/css" media="print"></head>
+
+<body>
+<h2>Tuscany CustomerInfo Sample</h2>
+
+<h3>Overview</h3>
+
+<p>The CustomerInfo sample shows a component exposing a WSDL portType interface
+ and a J2SE client using the dynamic SDO API to use the component.</p>
+
+<h3>Location</h3>This
+sample is located &nbsp;in the samples\sca\customerinfo directory.<br><br>
+
+<h3>Setup</h3>This sample depends on the Tuscany runtime and the sample jar, 
+
+    <span style="font-weight: bold;">
+    sample-customerinfo-incubating-M1.jar
+    </span>
+
+, both of these must be available on the classpath to run the sample.
+<ol>
+</ol>
+<h3>Running</h3>
+
+    In the directory samples/sca/customerinfo use the JDK 1.5 java command to run the class customerinfo.CustomerInfoClient
+
+    <pre>Linux: java -cp ../../../lib/tuscany-runtime-incubating-M1.jar:target/sample-customerinfo-incubating-M1.jar customerinfo.CustomerInfoClient</pre>
+    <pre>Windows: java -cp ../../../lib/tuscany-runtime-incubating-M1.jar;target/sample-customerinfo-incubating-M1.jar customerinfo.CustomerInfoClient</pre>
+
+<h3>Results</h3>
+<p>The sample when run should simply display to the standard
+output:<br> 
+<code>
+customerID = 12345<br>
+firstName = Jane<br>
+lastName = Doe<br>
+</code></p>
+<h3>Code Overview</h3>
+The source files are physically organized as shown below:
+<table style="text-align: left; width: 100%;" border="1" cellpadding="2" cellspacing="2"> <tbody> <tr><td>src<br>+---main<br>&nbsp;&nbsp;&nbsp; +---java<br>&nbsp;&nbsp;&nbsp; &brvbar;&nbsp;&nbsp; +---customerinfo<br>&nbsp;&nbsp;&nbsp; &brvbar;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CustomerInfoClient.java<br>&nbsp;&nbsp;&nbsp; &brvbar;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CustomerInfoServiceImpl.java<br>&nbsp;&nbsp;&nbsp; &brvbar;<br>&nbsp;&nbsp;&nbsp; +---resources<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; sca.module<br>&nbsp;&nbsp;&nbsp; +---wsdl<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; customer.xsd<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; customerinfo.wsdl</td></tr></tbody></table>
+<br>
+<table style="text-align: left; width: 879px; height: 154px;" border="0" cellpadding="2" cellspacing="2"> <tbody><tr><td style="vertical-align: top;">sca.module</td>
+<td>Defines the SCA module and component. Defines for the
+CustomerInfoServiceComponent component with the Java class that
+implements that component</td> </tr> 
+<tr> <td style="vertical-align: top;">CustomerInfoServiceImpl.java</td>
+<td>Implements the SCA component. Uses an  @SDOHelper anotation to have the SDO DataFactory automatically injected into the dataFacory field, and uses the DataFactory to create a cutomer DataObject which it initialises and returns to the caller.</td>
+</tr> <tr> <td style="vertical-align: top;">CustomerInfoClient .java</td>
+<td>Creates a Tuscany runtime and starts it. &nbsp;Obtains
+the module context which was defined by the sca.module file. From the
+module context locates the CustomerInfoServiceComponent, and then
+calls&nbsp; the getCustomerInfo method to invoke the component. It uses the SDO dynamic APIs to extract the information from the returned DataObject.</td>
+</tr> </tbody></table><br></body></html>
\ No newline at end of file

Modified: incubator/tuscany/java/samples/sca/readme.htm
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/samples/sca/readme.htm?rev=406987&r1=406986&r2=406987&view=diff
==============================================================================
--- incubator/tuscany/java/samples/sca/readme.htm (original)
+++ incubator/tuscany/java/samples/sca/readme.htm Tue May 16 09:50:39 2006
@@ -38,9 +38,7 @@
 
       <td style="vertical-align: top; white-space: nowrap;"><a href="helloworld/readme.htm" target="_blank">helloworld</a></td>
 
-      <td>Sample shows
-using the Tuscany SCA runtime in a J2SE environment &nbsp;loading a
-component.<br>
+      <td>Sample showing a J2SE client using the Tuscany SCA runtime and invoking a component.<br>
 
       <br>
 
@@ -52,8 +50,7 @@
 
       <td style="vertical-align: top; white-space: nowrap;"><a href="helloworldweb/readme.htm" target="_blank">helloworldweb</a>&nbsp;</td>
 
-      <td>Sample shows in a J2EE environment using SCA components to handle HTML
-forms.<br>
+      <td>Sample showing a J2EE web app client using the Tuscany SCA runtime and invoking a component.<br>
 
       <br>
 
@@ -65,10 +62,7 @@
 
       <td style="vertical-align: top; white-space: nowrap;"><a href="helloworldws/readme.htm" target="_blank">helloworldws</a>&nbsp;</td>
 
-      <td>Sample
-shows using the Tuscany SCA runtime in a Tomcat&nbsp; environment
-providing a
-web service&nbsp;<br>
+      <td>Sample showing a Tuscany SCA component exposed as a Web service endpoint.<br>
 
       <br>
 
@@ -80,9 +74,7 @@
 
       <td style="vertical-align: top; white-space: nowrap;"><a href="helloworldwsclient/readme.htm" target="_blank">helloworldwsclient</a>&nbsp;</td>
 
-      <td>Sample
-shows using the Tuscany SCA runtime in a J2SE environment using a
-web service&nbsp;<br>
+      <td>Sample showing a J2SE client using the Tuscany SCA runtime and invoking a remote Web service.<br>
 
       <br>
 
@@ -99,8 +91,8 @@
 <tr><td><a href="helloworldjsclient/readme.htm">helloworldjsclient</a></td><td>Another JSON-RPC web app sample showing a Web service client</td></tr>
 
 <tr><td><a href="calculator/readme.htm">calculator</a></td><td>Sample showing &nbsp;Tuscany SCA runtime using mutliple components.</td></tr>
-<tr><td>customerinfo</td><td>Sample showing &nbsp;a component &nbsp;exposing a WSDL &nbsp;portType interface and using the dynamic SDO API</td></tr>
-<tr><td>supplychain</td><td>Sample showing the use of Tuscany SCA asynchronous API</td></tr>
+<tr><td><a href="customerinfo/readme.htm">customerinfo</a></td><td>Sample showing &nbsp;a component &nbsp;exposing a WSDL &nbsp;portType interface and using the dynamic SDO API</td></tr>
+<tr><td><a href="supplychain/readme.htm">supplychain</a></td><td>Sample showing the use of Tuscany SCA asynchronous API</td></tr>
 
 
   </tbody>