svn commit: r389096 - /incubator/tuscany/java/samples/JavaScript/sample1/readme.htm

[an...@apache.org]

Author: antelder
Date: Mon Mar 27 03:00:01 2006
New Revision: 389096

URL: http://svn.apache.org/viewcvs?rev=389096&view=rev
Log:
Add a readme for JavaScript sample1

Added:
    incubator/tuscany/java/samples/JavaScript/sample1/readme.htm

Added: incubator/tuscany/java/samples/JavaScript/sample1/readme.htm
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/samples/JavaScript/sample1/readme.htm?rev=389096&view=auto
==============================================================================
--- incubator/tuscany/java/samples/JavaScript/sample1/readme.htm (added)
+++ incubator/tuscany/java/samples/JavaScript/sample1/readme.htm Mon Mar 27 03:00:01 2006
@@ -0,0 +1,118 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<!--
+  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.
+ -->
+<html><head>
+
+    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
+    <meta http-equiv="Content-Style-Type" content="text/css">
+    <title>Tuscany HelloWorld</title><!-- LINK rel="stylesheet" href="ait.css" type="text/css" --></head>
+
+<body>
+
+<h2>Tuscany JavaScript - Sample 1 - Hello World</h2>
+
+<h3>Overview</h3>
+
+<p>The Tuscany JavaScript Sample 1 shows using the Tuscany SCA runtime in a J2SE environment loading a JavaScript component that implements the classic introductory hello world example.</p>
+
+<h3>Setup</h3>The jars for a <a href="http://wiki.apache.org/ws/Tuscany/J2SESetup" target="_blank">J2SE setup</a> &nbsp;not requiring web
+services are required, allong with the JavaScript component container jar, <span style="font-weight: bold;">tuscany-container-js-SNAPSHOT.jar</span>
+, and the sample's own jar, <span style="font-weight: bold;">javascript-sample1-SNAPSHOT.jar</span>.
+
+<ol>
+</ol>
+
+<h3>Running</h3>
+
+Using the JDK 1.5 java command with the previous jars run the class sample.Sample1Client
+<br>
+
+<h3>Results</h3>
+
+<p>The sample when run should simply display to the standard output:<br>
+<br>
+
+    <code>jsHello World</code></p>
+
+<h3>Code Overview</h3>
+
+The source files are physically organized as shown below:
+<pre>sca.module
+<br>sample
+<br>+-- HelloWorld.java
+<br>+-- Sample1Client.java
+<br>+-- HelloWorldImpl.componentType
+<br>+-- HelloWorldImpl.js
+<br><br></pre>
+
+<p>&nbsp;</p>
+
+<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 'JavaScriptSample1' and a single component 'HelloWorldComponent'. 
+                The component uses the JavaScript componentType which gets the script source from the file 'sample/HelloWorldImpl.js'</td>
+
+        </tr>
+
+        <tr>
+
+            <td style="vertical-align: top;">HelloWorld.java</td>
+
+            <td>Defines the Java interface implemented by the component.</td>
+
+        </tr>
+
+        <tr>
+
+            <td style="vertical-align: top;">Sample1Client.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
+                HelloWorldComponent and then calls the getGreetings
+                method to invoke the component.</td>
+
+        </tr>
+
+        <tr>
+
+            <td style="vertical-align: top;">HelloWorldImpl.componentType</td>
+
+            <td>The SCA componentType side file defining the service interface implemented by the JavaScript component.</td>
+
+        </tr>
+
+        <tr>
+
+            <td style="vertical-align: top;">HelloWorldImpl.js</td>
+
+            <td>JavaScript implementation of the SCA component.</td>
+
+        </tr>
+
+    </tbody>
+</table>
+
+<br>
+
+</body></html>