From 15163ea2fd41b74b0e0a9fdb4b9746999e388e65 Mon Sep 17 00:00:00 2001 From: kelvingoodson Date: Mon, 24 May 2010 16:37:41 +0000 Subject: TUSCANY-3563 add readme to binding.rmi top level dir and fix launcher and osgi sample READMEs git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@947708 13f79535-47bb-0310-9956-ffa450edef68 --- sca-java-2.x/trunk/samples/binding-rmi/README | 1 + sca-java-2.x/trunk/samples/calculator-osgi/README | 195 +++++++++++---------- sca-java-2.x/trunk/samples/dosgi-calculator/README | 10 +- .../trunk/samples/launcher-embedded-jse/README | 10 ++ .../trunk/samples/launcher-embedded-osgi/README | 9 + 5 files changed, 124 insertions(+), 101 deletions(-) create mode 100644 sca-java-2.x/trunk/samples/binding-rmi/README (limited to 'sca-java-2.x/trunk/samples') diff --git a/sca-java-2.x/trunk/samples/binding-rmi/README b/sca-java-2.x/trunk/samples/binding-rmi/README new file mode 100644 index 0000000000..18ba62d494 --- /dev/null +++ b/sca-java-2.x/trunk/samples/binding-rmi/README @@ -0,0 +1 @@ +Please look at the README files in the subdirectories of this directory for descriptions of the sample contributions. diff --git a/sca-java-2.x/trunk/samples/calculator-osgi/README b/sca-java-2.x/trunk/samples/calculator-osgi/README index 332526d43a..f9a22d50f8 100644 --- a/sca-java-2.x/trunk/samples/calculator-osgi/README +++ b/sca-java-2.x/trunk/samples/calculator-osgi/README @@ -1,97 +1,98 @@ -Calculator Sample -================= -This sample implements a simple calculator using SCA components and run it in a OSGi environment. - -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 -jar ..\..\features\tuscany-sca-equinox-manifest.jar -composite Calculator.composite -config ..\..\features\configuration\ -ttl 0 target\sample-calculator-osgi.jar - -and on *nix do - -java -jar ../../features/tuscany-sca-equinox-manifest.jar -composite Calculator.composite -config ../../features/configuration/ -ttl 0 target/sample-calculator-osgi.jar - -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. +Calculator Sample +================= +This sample implements a simple calculator using SCA components and run it in a OSGi environment. + +The README in the /samples directory provides +general instructions about building and running samples. (where +distribution-unpack-dir is the directory in which you unpacked the tuscany +binary distribution archive). Take a look there first, noting that this is not a new style sample. + +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 -jar ..\..\features\tuscany-sca-equinox-manifest.jar -composite Calculator.composite -config ..\..\features\configuration\ -ttl 0 target\sample-calculator-osgi.jar + +and on *nix do + +java -jar ../../features/tuscany-sca-equinox-manifest.jar -composite Calculator.composite -config ../../features/configuration/ -ttl 0 target/sample-calculator-osgi.jar + +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/dosgi-calculator/README b/sca-java-2.x/trunk/samples/dosgi-calculator/README index d8aa13497a..03267b97e3 100644 --- a/sca-java-2.x/trunk/samples/dosgi-calculator/README +++ b/sca-java-2.x/trunk/samples/dosgi-calculator/README @@ -2,10 +2,12 @@ Distributed OSGi Calculator Sample ================================== This sample implements a distributed calculator using Distributed OSGi (RFC 119) over SCA. -The README in the samples directory (the directory above this) provides -general instructions about building and running samples. Take a look there -first. - +The README in the /samples directory provides +general instructions about building and running samples. ( where +distribution-unpack-dir is the directory in which you unpacked the tuscany +binary distribution archive). Take a look there +first, noting that this is not a new style sample. + On Windows, run java -jar ..\..\modules\osgi-3.5.0-v20090520.jar -configuration ..\..\features\configuration -clean -console diff --git a/sca-java-2.x/trunk/samples/launcher-embedded-jse/README b/sca-java-2.x/trunk/samples/launcher-embedded-jse/README index d4c29ade67..359e5d134d 100644 --- a/sca-java-2.x/trunk/samples/launcher-embedded-jse/README +++ b/sca-java-2.x/trunk/samples/launcher-embedded-jse/README @@ -8,3 +8,13 @@ The README file in the /samples directory provides general instructions about building and running sample contributions using the tuscany sample launchers ( where distribution-unpack-dir is the directory in which you unpacked the tuscany binary distribution archive) + +To use this sample JSE launcher with ant excute the command + +ant run- + +where run- is one of the targets in the build.xml file + +To use this sample launcher to run all of the contributions as junit test cases, +execute the command "mvn" in the launcher directory. + diff --git a/sca-java-2.x/trunk/samples/launcher-embedded-osgi/README b/sca-java-2.x/trunk/samples/launcher-embedded-osgi/README index e168759f8c..01d277ae09 100644 --- a/sca-java-2.x/trunk/samples/launcher-embedded-osgi/README +++ b/sca-java-2.x/trunk/samples/launcher-embedded-osgi/README @@ -9,3 +9,12 @@ general instructions about building and running sample contributions using the tuscany sample launchers. ( where distribution-unpack-dir is the directory in which you unpacked the tuscany binary distribution archive) + +To use this sample OSGI launcher with ant excute the command + +ant run- + +where run- is one of the targets in the build.xml file + +To use this sample launcher to run all of the contributions as junit test cases, +execute the command "mvn" in the launcher directory. -- cgit v1.2.3