TUSCANY-3938 - Correct sample documentation

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@1165598 13f79535-47bb-0310-9956-ffa450edef68

3 files changed, 41 insertions, 97 deletions

diff --git a/sca-java-2.x/trunk/samples/learning-more/contribution-osgi/README b/sca-java-2.x/trunk/samples/learning-more/contribution-osgi/README
deleted file mode 100644
index cde5fe981f..0000000000
--- a/sca-java-2.x/trunk/samples/learning-more/contribution-osgi/README
+++ /dev/null
@@ -1,97 +0,0 @@
-Calculator Sample

-=================

-This sample implements a simple calculator using SCA components. 

-

-The README in the samples directory (the directory above this) provides 

-general instructions about building and running samples. Take a look there 

-first. 

-

-If you just want to run it to see what happens open a command prompt, navigate

-to this sample directory and do:

-

-ant run

-

-OR if you don't have ant, on Windows do

-

-java -cp ..\..\lib\tuscany-sca-manifest.jar;target\sample-calculator.jar calculator.CalculatorClient

-

-and on *nix do

-

-java -cp ../../lib/tuscany-sca-manifest.jar:target/sample-calculator.jar calculator.CalculatorClient

-

-Sample Overview

----------------

-The sample provides a single calculator service with a default SCA (java) 

-binding. The CalculatorClient exercises this interface by calling add, 

-subtract, multiply and divide operations. This results in messages passing to 

-the appropriate components in the composite across the local wires.

-

-calculator/

-  src/

-    main/

-      java/

-        calculator/

-          CalculatorService.java  - the first component, calls +-/* as 

-                                    appropriate

-          CalculatorServiceImpl.java

-          AddService.java         - adds two numbers

-          AddServiceImpl.java

-          SubtractService.java    - subtracts one number from another

-          SubtractServiceImpl.java

-          MultiplyService.java    - multiplies two numbers

-          MultiplyServiceImpl.java

-          DivideService.java      - divides one number by another

-          DivideServiceImpl.java

-          CalculatorClient.java   - starts the SCA Runtime and 

-                                    deploys the Calculator.composite. 

-                                    It then calls the deployed Calculator 

-                                    Components services

-      resources/

-        Calculator.composite      - the SCA assembly for this sample

-    test/

-      java/

-        calculator/

-          CalculatorTestCase.java - JUnit test case 

-  calculator.png                  - a pictorial representation of the sample 

-                                    .composite file

-  build.xml                       - the Ant build file

-  pom.xml                         - the Maven build file        

-

-Building And Running The Sample Using Ant

------------------------------------------

-With the binary distribution the sample can be built and run using Ant as 

-follows

-

-cd calculator

-ant compile

-ant run

-

-You should see the following output from the run target.

-

-run:

-     [java] 3 + 2=5.0

-     [java] 3 - 2=1.0

-     [java] 3 * 2=6.0

-     [java] 3 / 2=1.5

-

-Building And Running The Sample Using Maven 

--------------------------------------------

-With either the binary or source distributions the sample can be built and run 

-using Maven as follows. 

-

-cd calculator

-mvn

-

-You should see the following output from the test phase.

-

--------------------------------------------------------

- T E S T S

--------------------------------------------------------

-Running calculator.CalculatorTestCase

-Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.272 sec

-

-Results :

-

-Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

-

-This shows that the Junit test cases have run successfully. 

diff --git a/sca-java-2.x/trunk/samples/learning-more/contribution-osgi/README.html b/sca-java-2.x/trunk/samples/learning-more/contribution-osgi/README.html
new file mode 100644
index 0000000000..d785a5c7a4
--- /dev/null
+++ b/sca-java-2.x/trunk/samples/learning-more/contribution-osgi/README.html
@@ -0,0 +1,41 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

+<HTML>

+<HEAD>

+	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">

+	<TITLE></TITLE>

+	<META NAME="GENERATOR" CONTENT="OpenOffice.org 3.3  (Win32)">

+	<META NAME="AUTHOR" CONTENT="ant ">

+	<META NAME="CREATED" CONTENT="20110315;9485571">

+	<META NAME="CHANGED" CONTENT="20110906;11493347">

+	<STYLE TYPE="text/css">

+	<!--

+		@page { margin: 2cm }

+		P { margin-bottom: 0.21cm }

+		H1 { margin-bottom: 0.21cm }

+		H1.western { font-family: "Arial", sans-serif; font-size: 16pt }

+		H1.cjk { font-family: "SimSun"; font-size: 16pt }

+		H1.ctl { font-family: "Mangal"; font-size: 16pt }

+		PRE.cjk { font-family: "NSimSun", monospace }

+		A:link { so-language: zxx }

+	-->

+	</STYLE>

+</HEAD>

+<BODY LANG="en-GB" DIR="LTR">

+<H1 CLASS="western">Contribution OSGi</H1>

+<P STYLE="margin-bottom: 0cm"><BR>

+</P>

+<PRE CLASS="western"><FONT FACE="Times New Roman, serif"><FONT SIZE=3>This sample packages the calculator sample as an OSGi bundle. The main differences over and above the basic calculator sample is that the bundle has a bundle activator. When the bundle is installed and started in OSGi the bundle activator starts the Tuscany runtime and runs the sample. </FONT></FONT>

+

+<FONT FACE="Times New Roman, serif"><FONT SIZE=3>See samples/running_tuscany/osgi for instructions for installing the Tuscany runtime in OSGi. Once the runtime is installed this contribution can be installed from the OSGi command line using the following command. </FONT></FONT>

+

+<FONT FACE="Courier New, monospace"><FONT SIZE=2>osgi&gt; install file:///c:\path\to\Tuscany\installation\samples\learning-more\contribution-osgi\target\sample-contribution-osgi.jar</FONT></FONT>

+

+<FONT FACE="Times New Roman, serif"><FONT SIZE=3>This should give rise to a message indicating the bundle ID as follows:</FONT></FONT>

+

+<FONT FACE="Courier New, monospace"><FONT SIZE=2>Bundle id is 264</FONT></FONT>

+

+<FONT FACE="Times New Roman, serif"><FONT SIZE=3>The bundle can then be started using:</FONT></FONT>

+

+<FONT FACE="Courier New, monospace"><FONT SIZE=2>osgi&gt; start 264</FONT></FONT></PRE>

+</BODY>

+</HTML>
\ No newline at end of file
diff --git a/sca-java-2.x/trunk/samples/learning-more/contribution-osgi/README.odt b/sca-java-2.x/trunk/samples/learning-more/contribution-osgi/README.odt
index c560586529..934c402bdf 100644
--- a/sca-java-2.x/trunk/samples/learning-more/contribution-osgi/README.odt
+++ b/sca-java-2.x/trunk/samples/learning-more/contribution-osgi/README.odt