Author: ccustine
Date: Thu Oct 22 15:30:04 2009
New Revision: 828746
URL: http://svn.apache.org/viewvc?rev=828746&view=rev
Log:
SMX4-404 - Updates to ServiceMix example readmes
Modified:
servicemix/smx4/features/trunk/examples/README.txt
servicemix/smx4/features/trunk/examples/camel-osgi/README.txt
servicemix/smx4/features/trunk/examples/cxf-jaxrs/README.txt
servicemix/smx4/features/trunk/examples/cxf-osgi/README.txt
servicemix/smx4/features/trunk/examples/cxf-ws-addressing/README.txt
servicemix/smx4/features/trunk/examples/cxf-wsdl-first-osgi-package/README.txt
servicemix/smx4/features/trunk/examples/cxf-wsdl-first/README.txt
Modified: servicemix/smx4/features/trunk/examples/README.txt
URL:
http://svn.apache.org/viewvc/servicemix/smx4/features/trunk/examples/README.txt?rev=828746&r1=828745&r2=828746&view=diff
==============================================================================
--- servicemix/smx4/features/trunk/examples/README.txt (original)
+++ servicemix/smx4/features/trunk/examples/README.txt Thu Oct 22 15:30:04 2009
@@ -76,6 +76,26 @@
- cxf-wsdl-first-osgi-package
Publishes, as OSGi bundles, a WSDL-defined web service created using CXF.
+
+- interceptors
+ Contains two interceptor examples:
+
+ 1. /endpoint
+ Deploys a custom endpoint listener that captures and reports, to
+ the ServiceMix log, when an endpoint registers and unregisters with
+ the NMR.
+
+ 2. /exchange
+ Deploys a custom exchange listener that captures and reports, to
+ the ServiceMix log, the exchanges that are sent and delivered using
+ the NMR.
+
+- karaf-demos/web
+ Embeds the ServiceMix Kernel in a web application.
+
+- nmr
+ Exposes a simple NMR endpoint.
+
- simple
Adds new endpoints using XML configuration files only.
Modified: servicemix/smx4/features/trunk/examples/camel-osgi/README.txt
URL:
http://svn.apache.org/viewvc/servicemix/smx4/features/trunk/examples/camel-osgi/README.txt?rev=828746&r1=828745&r2=828746&view=diff
==============================================================================
--- servicemix/smx4/features/trunk/examples/camel-osgi/README.txt (original)
+++ servicemix/smx4/features/trunk/examples/camel-osgi/README.txt Thu Oct 22
15:30:04 2009
@@ -117,7 +117,7 @@
2. Copy the updated configuration file to your <servicemix_home>/etc
directory. You can do this from the ServiceMix console by typing:
- copy /examples/camel-osgi/org.apache.servicemix.examples.cfg
+ copy
$YOUR_SERVICEMIX_HOME/examples/camel-osgi/org.apache.servicemix.examples.cfg
$YOUR_SERVICEMIX_HOME/etc
On Windows you need to replace / in the path with \\.
Modified: servicemix/smx4/features/trunk/examples/cxf-jaxrs/README.txt
URL:
http://svn.apache.org/viewvc/servicemix/smx4/features/trunk/examples/cxf-jaxrs/README.txt?rev=828746&r1=828745&r2=828746&view=diff
==============================================================================
--- servicemix/smx4/features/trunk/examples/cxf-jaxrs/README.txt (original)
+++ servicemix/smx4/features/trunk/examples/cxf-jaxrs/README.txt Thu Oct 22
15:30:04 2009
@@ -97,7 +97,7 @@
Running a Client
----------------
-You can browse WADL at
+You can browse WSDL at:
http://localhost:8191/cxf/crm/customerservice?_wadl&_type=xml
@@ -105,11 +105,11 @@
http://localhost:8191/cxf/crm?_wadl&_type=xml
-The latter URI can be used to see the desription of multiple root resource
classes.
+The latter URI can be used to see the desription of multiple root
+resource classes.
You can see the services listing at http://localhost:8191/cxf.
-
You can make invocations on the web service in several ways, including
using a web client, using a Java client and using a command-line
utility such a curl or Wget. See below for more details.
@@ -133,7 +133,8 @@
mvn compile exec:java
-It makes a sequence of RESTful invocations and displays the results.
+ It makes a sequence of RESTful invocations and displays the
+ results.
(c) To run a command-line utility:
-----------------------------
@@ -162,17 +163,24 @@
#
curl -X DELETE http://localhost:8181/cxf/crm/customerservice/customers/123
+
Changing /cxf servlet alias
---------------------------
-By default CXF Servlet is assigned a '/cxf' alias. You can change it in a
couple of ways
+By default CXF Servlet is assigned a '/cxf' alias. You can
+change it in a couple of ways
-a. Add org.apache.cxf.osgi.cfg to /etc directory and set the
'org.apache.cxf.servlet.context' property, for example :
+a. Add org.apache.cxf.osgi.cfg to the /etc directory and set the
+ 'org.apache.cxf.servlet.context' property, for example:
+
org.apache.cxf.servlet.context=/custom
-b. Use shell config commands, for example :
- config:edit org.apache.cxf.osgi
- config:propset org.apache.cxf.servlet.context /super
- config:update
+
+b. Use shell config commands, for example:
+
+ config:edit org.apache.cxf.osgi
+ config:propset org.apache.cxf.servlet.context /super
+ config:update
+
B. Building the Example Bundle Yourself
---------------------------------------
To install and run the example where you build the example bundle
@@ -252,4 +260,4 @@
directory of your ServiceMix installation, or by typing
the following command in the ServiceMix console:
- log:display
\ No newline at end of file
+ log:display
Modified: servicemix/smx4/features/trunk/examples/cxf-osgi/README.txt
URL:
http://svn.apache.org/viewvc/servicemix/smx4/features/trunk/examples/cxf-osgi/README.txt?rev=828746&r1=828745&r2=828746&view=diff
==============================================================================
--- servicemix/smx4/features/trunk/examples/cxf-osgi/README.txt (original)
+++ servicemix/smx4/features/trunk/examples/cxf-osgi/README.txt Thu Oct 22
15:30:04 2009
@@ -87,9 +87,6 @@
more information about the features facility, see the README.txt
file in the examples parent directory.
-When the feature is installed, output for publishing the CXF
-endpoint is displayed to the console.
-
To view the service WSDL, open your browser and go to the following
URL:
@@ -107,6 +104,18 @@
2. Click the Send button to send a request.
+ Once the request has been successfully sent, a response similar
+ to the following should appear in the right-hand panel of the
+ web page:
+
+ STATUS: 200
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/";>
+ <soap:Body><ns2:sayHiResponse xmlns:ns2="http://cxf.examples.
+ servicemix.apache.org/"><return>Hello John Doe</return>
+ </ns2:sayHiResponse>
+ </soap:Body>
+ </soap:Envelope>
+
To run the java code client:
1. Change to the <servicemix_home>/examples/cxf-osgi
@@ -116,17 +125,33 @@
mvn compile exec:java
+ If the client request is successful, a response similar to the
+ following should appear in the ServiceMix console:
+
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/";>
+ <soap:Body><ns2:sayHiResponse xmlns:ns2="http://cxf.examples.
+ servicemix.apache.org/"><return>Hello John Doe</return>
+ </ns2:sayHiResponse>
+ </soap:Body>
+ </soap:Envelope>
+
Changing /cxf servlet alias
---------------------------
-By default CXF Servlet is assigned a '/cxf' alias. You can change it in a
couple of ways
+By default CXF Servlet is assigned a '/cxf' alias. You can
+change it in a couple of ways
-a. Add org.apache.cxf.osgi.cfg to /etc directory and set the
'org.apache.cxf.servlet.context' property, for example :
- org.apache.cxf.servlet.context=/custom
+a. Add org.apache.cxf.osgi.cfg to the /etc directory and set
+ the 'org.apache.cxf.servlet.context' property, for example:
+
+ org.apache.cxf.servlet.context=/custom
+
b. Use shell config commands, for example :
- config:edit org.apache.cxf.osgi
- config:propset org.apache.cxf.servlet.context /super
- config:update
+
+ config:edit org.apache.cxf.osgi
+ config:propset org.apache.cxf.servlet.context /super
+ config:update
+
B. Building the Example Bundle Yourself
---------------------------------------
@@ -163,10 +188,6 @@
information about the features facility, see the README.txt file
in the examples parent directory.
-
-When the feature is installed, output for publishing the CXF
-endpoint is displayed to the console.
-
To view the service WSDL, open your browser and go to the following
URL:
@@ -183,15 +204,14 @@
-------------------------------------
To stop the example, you must first know the bundle ID that ServiceMix
has assigned to it. To get the bundle ID, enter the following command
-at the ServiceMix console (Note, the text you are typing will intermingle
-with the output being logged. This is nothing to worry about.):
+at the ServiceMix console:
osgi:list
At the end of the listing, you should see an entry similar to the
following:
- [170] [Active ] [Started] [ 60] Apache ServiceMix Example :: CXF OSGi
(4.1.0)
+ [170] [Active ] [Started] [ 60] Apache ServiceMix Example :: CXF OSGi
(4.2.0.0)
In this case, the bundle ID is 170.
Modified: servicemix/smx4/features/trunk/examples/cxf-ws-addressing/README.txt
URL:
http://svn.apache.org/viewvc/servicemix/smx4/features/trunk/examples/cxf-ws-addressing/README.txt?rev=828746&r1=828745&r2=828746&view=diff
==============================================================================
--- servicemix/smx4/features/trunk/examples/cxf-ws-addressing/README.txt
(original)
+++ servicemix/smx4/features/trunk/examples/cxf-ws-addressing/README.txt Thu
Oct 22 15:30:04 2009
@@ -160,7 +160,29 @@
2. Click the Send button to send a request.
- You should receive a SOAP message as a response.
+ Once the request has been successfully sent, you should receive
+ a SOAP message similar to the following as a response. It should
+ appear in the right-hand panel of the web page:
+
+ STATUS: 200
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/";>
+ <soap:Header>
+ <Action xmlns="http://www.w3.org/2005/08/addressing";>
+ http://apache.org/hello_world_soap_http/Greeter/sayHiResponse
+ </Action>
+ <MessageID xmlns="http://www.w3.org/2005/08/addressing";>
+ urn:uuid:4352861b-3451-4ae8-b97f-11f7e2535807</MessageID>
+ <To xmlns="http://www.w3.org/2005/08/addressing";>
+ http://www.w3.org/2005/08/addressing/anonymous</To>
+ <RelatesTo xmlns="http://www.w3.org/2005/08/addressing";>
+ urn:uuid:10fb2ee6-43db-4d88-a3e5-6316f1763669</RelatesTo>
+ </soap:Header>
+ <soap:Body>
+ <sayHiResponse xmlns="http://apache.org/hello_world_soap_http/types";>
+ <responseType>Bonjour</responseType>
+ </sayHiResponse>
+ </soap:Body>
+ </soap:Envelope>
To run the java code client:
@@ -172,19 +194,26 @@
mvn compile exec:java
- It makes an invocation with WS-Addressing headers and displays
- the response.
+ It makes an invocation with WS-Addressing headers and displays,
+ in the ServiceMix console, a response similar to that shown
+ in the web client (see above).
Changing /cxf servlet alias
---------------------------
-By default CXF Servlet is assigned a '/cxf' alias. You can change it in a
couple of ways
+By default CXF Servlet is assigned a '/cxf' alias. You can
+change it in a couple of ways:
+
+a. Add org.apache.cxf.osgi.cfg to the /etc directory and
+ set the 'org.apache.cxf.servlet.context' property, for example:
+
+ org.apache.cxf.servlet.context=/custom
+
+b. Use shell config commands, for example:
+
+ config:edit org.apache.cxf.osgi
+ config:propset org.apache.cxf.servlet.context /super
+ config:update
-a. Add org.apache.cxf.osgi.cfg to /etc directory and set the
'org.apache.cxf.servlet.context' property, for example :
- org.apache.cxf.servlet.context=/custom
-b. Use shell config commands, for example :
- config:edit org.apache.cxf.osgi
- config:propset org.apache.cxf.servlet.context /super
- config:update
B. Building the Example Bundle Yourself
---------------------------------------
@@ -222,10 +251,6 @@
information about the features facility, see the README.txt file
in the examples parent directory.
-
-When the feature is installed, output for publishing the CXF
-endpoint is displayed to the console.
-
To view the service WSDL, open your browser and go to the following
URL:
@@ -251,7 +276,7 @@
At the end of the listing, you should see an entry similar to the
following:
- [171] [Active ] [Started] [ 60] Apache ServiceMix Example :: CXF
WS-ADDRESSING OSGI (4.1.0)
+ [171] [Active ] [Started] [ 60] Apache ServiceMix Example :: CXF
WS-ADDRESSING OSGI (4.2.0)
In this case, the bundle ID is 171.
@@ -280,4 +305,4 @@
directory of your ServiceMix installation, or by typing
the following command in the ServiceMix console:
- log:display
\ No newline at end of file
+ log:display
Modified:
servicemix/smx4/features/trunk/examples/cxf-wsdl-first-osgi-package/README.txt
URL:
http://svn.apache.org/viewvc/servicemix/smx4/features/trunk/examples/cxf-wsdl-first-osgi-package/README.txt?rev=828746&r1=828745&r2=828746&view=diff
==============================================================================
---
servicemix/smx4/features/trunk/examples/cxf-wsdl-first-osgi-package/README.txt
(original)
+++
servicemix/smx4/features/trunk/examples/cxf-wsdl-first-osgi-package/README.txt
Thu Oct 22 15:30:04 2009
@@ -16,7 +16,7 @@
*/
WSDL First OSGi Bundles Example
-===================================
+===============================
Purpose
-------
@@ -83,78 +83,17 @@
For more information, see the README in the top-level examples
directory.
-
2. Start ServiceMix by running the following command:
<servicemix_home>/bin/servicemix (on UNIX)
<servicemix_home>\bin\servicemix (on Windows)
-Running the Example
--------------------
-You can run the example in two ways:
-
-- A. Using a Prebuilt Deployment Bundle: Quick and Easy
-This option is useful if you want to see the example up and
-running as quickly as possible.
-
-- B. Building the Example Bundle Yourself
-This option is useful if you want to change the example in any
-way. It tells you how to build and deploy the example. This
-option might be slower than option A because, if you do not
-already have the required bundles in your local Maven
-repository, Maven will have to download the bundles it needs.
-
-A. Using a Prebuilt Deployment Bundle: Quick and Easy
------------------------------------------------------
-To install and run a prebuilt version of this example, enter
-the following command in the ServiceMix console:
-
- features:install examples-cxf-wsdl-first-osgi-package
-
-This command makes use of the ServiceMix features facility. For
-more information about the features facility, see the README.txt
-file in the examples parent directory.
-
-You can browse the WSDL at:
-
- http://localhost:8092/PersonService?wsdl
-
-Note, if you use Safari, right click the window and select
-'Show Source'.
-
-Running a Client
-----------------
-To run the web client:
-
-1. Open the client.html, which is located in the same directory as
- this README file, in your favorite browser.
-
-2. Click the Send button to send a request.
+Building and Running the Example
+--------------------------------
+To build and run the example, complete the following steps:
-To run the java code client:
-
-1. Change to the <servicemix_home>/examples/cxf-wsdl-first-osgi-package
- directory.
-
-2. Run the following command:
-
- mvn compile exec:java
-
-
-B. Building the Example Bundle Yourself
----------------------------------------
-To install and run the example where you build the example bundle
-yourself, complete the following steps:
-
-1. If you have already run the example using the prebuilt version as
- described above, you must first uninstall the
- examples-cxf-wsdl-first-osgi-package feature by entering the
- following command in the ServiceMix console:
-
- features:uninstall examples-cxf-wsdl-first-osgi-package
-
-2. Build the example by opening a command prompt, changing directory
+1. Build the example by opening a command prompt, changing directory
to examples/cxf-wsdl-first-osgi-package (this example) and entering
the following Maven command:
@@ -168,7 +107,7 @@
copies it to your local Maven repository and to the target directory
of this example.
-3. Install the example by entering the following command in
+2. Install the example by entering the following command in
the ServiceMix console:
features:install examples-cxf-wsdl-first-osgi-package
@@ -184,26 +123,64 @@
Note, if you use Safari, right click the window and select
'Show Source'.
-You can try running a client against your service by following the
-instructions in the "Running a Client" section above.
+Running a Client
+----------------
+To run the web client:
+
+1. Open the client.html, which is located in the same directory as
+ this README file, in your favorite browser.
+
+2. Click the Send button to send a request.
+
+ Once the request has been successfully sent, a response similar
+ to the following should appear in the right-hand panel of the
+ web page:
+
+ STATUS: 200
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/";>
+ <soap:Body><GetPersonResponse xmlns="http://servicemix.apache.org/
+ samples/wsdl-first/types"><personId>world</personId>
+ <ssn>000-000-0000</ssn><name>Guillaume</name></GetPersonResponse>
+ </soap:Body>
+ </soap:Envelope>
+
+To run the java code client:
+
+1. Change to the <servicemix_home>/examples/cxf-wsdl-first-osgi-package/
+ client directory.
+
+2. Run the following command:
+
+ mvn compile exec:java
+
+ If the client request is successful, a response similar to the
+ following should appear in the ServiceMix console:
+
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/";>
+ <soap:Body><GetPersonResponse xmlns="http://servicemix.apache.org/
+ samples/wsdl-first/types"><personId>world</personId>
+ <ssn>000-000-0000</ssn><name>Guillaume</name></GetPersonResponse>
+ </soap:Body>
+ </soap:Envelope>
+
Stopping and Uninstalling the Example
-------------------------------------
To stop the example, you must first know the bundle ID that ServiceMix
has assigned to it. To get the bundle ID, enter the following command
-in the ServiceMix console (Note, the text you are typing will
-intermingle with the output being logged. This is nothing to worry
-about.):
+in the ServiceMix console:
osgi:list
At the end of the listing, you should see an entry similar to the
following:
- [172] [Active ] [Started] [ 60] Apache ServiceMix Example :: CXF OSGi
(4.1.0)
+ [180] [Active ] [ ] [ 60] ServiceMix :: Samples :: WSDL first ::
CXF BC BUNDLE (4.2.0)
+ [181] [Active ] [ ] [ 60] ServiceMix :: Samples :: WSDL first ::
CXF SE BUNDLE (4.2.0)
-In this case, the bundle ID is 172.
+
+In this case, the bundle IDs are 180 and 181.
To stop the example, enter the following command in the ServiceMix
console:
@@ -212,7 +189,8 @@
For example:
- osgi:stop 172
+ osgi:stop 180
+ osgi:stop 181
To uninstall the example, enter one of the following commands in
the ServiceMix console:
@@ -233,6 +211,12 @@
log:display
+Changing the Example
+--------------------
+If you want to change the code or configuration, just use 'mvn install'
+to rebuild the OSGi bundles and deploy as before.
+
+
More Information
----------------
For more information, see:
Modified: servicemix/smx4/features/trunk/examples/cxf-wsdl-first/README.txt
URL:
http://svn.apache.org/viewvc/servicemix/smx4/features/trunk/examples/cxf-wsdl-first/README.txt?rev=828746&r1=828745&r2=828746&view=diff
==============================================================================
--- servicemix/smx4/features/trunk/examples/cxf-wsdl-first/README.txt (original)
+++ servicemix/smx4/features/trunk/examples/cxf-wsdl-first/README.txt Thu Oct
22 15:30:04 2009
@@ -22,9 +22,9 @@
-------
Publish a WSDL-defined web service, as a JBI service assembly, using CXF.
-This example is the same as the cxf-wsdl-first-osgi example except it is
-deployed as a JBI service assembly, whereas the cxf-wsdl-first-osgi
-example is deployed as OSGi bundles.
+This example is the same as the cxf-wsdl-first-osgi-package example except
+it is deployed as a JBI service assembly, whereas the cxf-wsdl-first-osgi-
+package example is deployed as OSGi bundles.
Explanation
@@ -69,7 +69,8 @@
targetInterface="person:Person"/>
Lastly, Maven uses the pom.xml file, located in the wsdl-first-cxf-sa
-directory, to package the SUs into a JBI service assembly ready for deployment.
+directory, to package the SUs into a JBI service assembly (SA) ready
+for deployment.
Prerequisites for Building and Running this Example
@@ -100,7 +101,7 @@
repository, the example will build quickly. Otherwise it may take
some time for Maven to download everything it needs.
-Once complete, you will find the SA, called cxf-wsdl-first-cxf-sa-
+Once complete, you will find the SA, called wsdl-first-cxf-sa-
${version}.zip, in the wsdl-first-cxf-sa/target directory.
You can deploy the SA in two ways:
@@ -132,7 +133,19 @@
2. Click the Send button to send a request.
-To run the java code client:
+ Once the request has been successfully sent, a response similar
+ to the following should appear in the right-hand panel of the
+ web page:
+
+ STATUS: 200
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/";>
+ <soap:Body><GetPersonResponse xmlns="http://servicemix.apache.org/
+ samples/wsdl-first/types"><personId>world</personId>
+ <ssn>000-000-0000</ssn><name>Guillaume</name></GetPersonResponse>
+ </soap:Body>
+ </soap:Envelope>
+
+To run the Java code client:
1. Change to the <servicemix_home>/examples/cxf-wsdl-first/client
directory.
@@ -140,18 +153,56 @@
2. Run the following command:
mvn compile exec:java
+
+ If the client request is successful, a response similar to the
+ following should appear in the ServiceMix console:
+
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/";>
+ <soap:Body><GetPersonResponse xmlns="http://servicemix.apache.org/
+ samples/wsdl-first/types"><personId>world</personId>
+ <ssn>000-000-0000</ssn><name>Guillaume</name></GetPersonResponse>
+ </soap:Body>
+ </soap:Envelope>
+
+
+Stopping and Uninstalling the Example
+-------------------------------------
+To stop the example, you must first know the bundle ID that ServiceMix
+has assigned to it. To get the bundle ID, enter the following command
+in the ServiceMix console:
+
+ osgi:list
+
+At the end of the listing, you should see an entry similar to one of
+the following (depending on how you deployed the example):
+
+[ 183] [Active ] [ ] [ ] [ 60]
mvn:org.apache.servicemix.examples.cxf-wsdl-first/wsdl-first-cxf-sa/${version}/zip
+
+[ 183] [Active ] [ ] [ ] [ 60] wsdl-first-cxf-sa (0.0.0)
+
+In this case, the bundle ID is 183.
+
+To stop the example, enter the following command in the ServiceMix
+console:
+
+ osgi:stop <bundle_id>
+
+To uninstall the example, enter the following command in the
+ServiceMix console:
+
+ osgi:uninstall <bundle_id>
Viewing the Log Entries
-----------------------
-You can view the entries in the log file in the data/log
-directory of your ServiceMix installation, or by typing
-the following command in the ServiceMix console:
+You can view the entries in the log file in the data/log directory
+of your ServiceMix installation, or by typing the following command
+in the ServiceMix console:
log:display
Changing the Example
--------------------
-If you wish to change the code or configuration, just use 'mvn install'
-to rebuild the JBI Service Assembly zip, and deploy it as before.
+If you want to change the code or configuration, just use 'mvn install'
+to rebuild the JBI Service Assembly zip file, and deploy it as before.
\ No newline at end of file
