From c585fbe90efd378950ac3df9d83f838a2cb12f9d Mon Sep 17 00:00:00 2001 From: kelvingoodson Date: Mon, 24 May 2010 10:18:29 +0000 Subject: TUSCANY-3563 more new style READMEs for launcher/contribution style of invoking git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@947588 13f79535-47bb-0310-9956-ffa450edef68 --- .../binding-sca/contribution-calculator/README | 101 ++------------------- .../README | 87 ++---------------- 2 files changed, 17 insertions(+), 171 deletions(-) (limited to 'sca-java-2.x') diff --git a/sca-java-2.x/trunk/samples/binding-sca/contribution-calculator/README b/sca-java-2.x/trunk/samples/binding-sca/contribution-calculator/README index 20a913075c..4777c5ad88 100644 --- a/sca-java-2.x/trunk/samples/binding-sca/contribution-calculator/README +++ b/sca-java-2.x/trunk/samples/binding-sca/contribution-calculator/README @@ -1,35 +1,13 @@ -Calculator Sample -================= -This sample implements a simple calculator using SCA components. It also optionally demonstrates tracing Tuscany code. +Calculator Sample Contribution +============================== -The README in the samples directory (the directory above this) provides -general instructions about building and running samples. Take a look there -first. +This sample contribution implements a simple calculator using SCA components. -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 ..\..\features\tuscany-sca-manifest.jar;target\sample-calculator.jar calculator.CalculatorClient - -and on *nix do - -java -cp ../../features/tuscany-sca-manifest.jar:target/sample-calculator.jar calculator.CalculatorClient - -If you want to see an example of tracing the Tuscany code ... then try the command ---------------------------------------------------------- -ant runtraced - -or on Windows run the command - -java -javaagent:..\..\bin/aspectjweaver.jar -cp ..\..\features\tuscany-sca-manifest.jar;target\sample-calculator.jar calculator.CalculatorClient - -or on *nix run the command - -java -javaagent:../../bin/aspectjweaver.jar -cp ../../features/tuscany-sca-manifest.jar:target/sample-calculator.jar calculator.CalculatorClient +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 for instructions on how to launch +this sample contribution. Sample Overview --------------- @@ -38,47 +16,7 @@ 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. +Amongst the other output created by the launcher/contribution combination, you should see the following output ... run: [java] 3 + 2=5.0 @@ -86,24 +24,3 @@ run: [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/contribution-implementation-java-calculator/README b/sca-java-2.x/trunk/samples/contribution-implementation-java-calculator/README index 28eccbdebb..acf18ec8d9 100644 --- a/sca-java-2.x/trunk/samples/contribution-implementation-java-calculator/README +++ b/sca-java-2.x/trunk/samples/contribution-implementation-java-calculator/README @@ -1,22 +1,13 @@ -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 +Calculator Sample Contribution +============================== -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-implementation-java-calculator.jar -and on *nix do +This sample implements a simple calculator using SCA components. -java -jar ../../features/tuscany-sca-equinox-manifest.jar -composite Calculator.composite -config ../../features/configuration/ -ttl 0 target/sample-implementation-java-calculator.jar +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 for instructions on how to launch +this sample contribution. Sample Overview --------------- @@ -25,46 +16,6 @@ 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: @@ -72,25 +23,3 @@ run: [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. -- cgit v1.2.3