CAMEL-9337 Add readme.txt to all examples
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/403089fa Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/403089fa Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/403089fa Branch: refs/heads/master Commit: 403089fae06608c3b0c71ca5c53159fce4ce4864 Parents: bc2a393 Author: gautric <gaut...@redhat.com> Authored: Wed Dec 9 19:27:30 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Thu Dec 10 07:44:59 2015 +0100 ---------------------------------------------------------------------- examples/camel-example-cxf-osgi/README.md | 110 +++++++++++++++++++++++ examples/camel-example-cxf-osgi/README.txt | 100 --------------------- examples/camel-example-cxf-proxy/README.md | 63 +++++++++++++ examples/camel-example-cxf-proxy/README.txt | 55 ------------ 4 files changed, 173 insertions(+), 155 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/403089fa/examples/camel-example-cxf-osgi/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-cxf-osgi/README.md b/examples/camel-example-cxf-osgi/README.md new file mode 100644 index 0000000..383c254 --- /dev/null +++ b/examples/camel-example-cxf-osgi/README.md @@ -0,0 +1,110 @@ +# CXF OSGI Example +================ + +### Introduction + +A simple example which receives web service calls (via a CXF consumer, using bean binding) +and writes these requests into the file system. It's not a very useful use case, but the goal +of this example is to show you how you can use the CXF consumer component in an OSGI +environment with the OSGI HTTP service. If your target container is Apache Karaf or Apache +ServiceMix, you can use PAX Web to setup and start an OSGI HTTP service. All Camel +bundles using a Camel CXF consumer can use this HTTP service without needing to start +individual Jetty instances. Another advantage is that all provided services can now share +the same port. + +### Build + +You will need to compile the example first: + + mvn install + +Remarks: +- During the compilation phase, a unit test will be performed which simulates the + client calling the web service exposed by our camel/cxf route. +- In Eclipse, I have used the following option when starting the junit test case. This option tells + CXF that it must use log4j : -Dorg.apache.cxf.Logger=org.apache.cxf.common.logging.Log4jLogger + +### Run + +To run the example on Apache ServiceMix 4.x or Apache Karaf 2.2.x + +#### Step 1: launch the server + + karaf / karaf.bat + +Note for Karaf 2.2.x: + a) edit the etc/jre.properties file to add the following packages to be exported + jre-1.6=, \ + com.sun.org.apache.xerces.internal.dom, \ + com.sun.org.apache.xerces.internal.jaxp, \ + + b) from the same file comment out the following exports already provided by the bundles + that will be imported next: javax.xml.bind*, javax.jws*, javax.xml.soap*, javax.xml.ws*, + javax.activation, javax.annotation, javax.xml.stream*. + + +#### Step 2: Add features required + + features:addUrl mvn:org.apache.camel.karaf/apache-camel/${version}/xml/features + features:install war + features:install cxf + features:install camel-spring + features:install camel-jaxb + features:install camel-cxf + + +#### Step 3: Deploy the example + osgi:install -s mvn:org.apache.camel/camel-example-cxf-osgi/${version} + +#### Step 4: Verify that your service is available using the following url in the browser. +We assume you're using Karaf's default PAX Web configuration which uses +port `8181` for http. If you would like to use another port or https, change the configuration in +`${KARAF_HOME}/etc/org.ops4j.pax.web.cfg`. The immediate extension after the hostname and port ("cxf" in +the below URL) is configured via the org.apache.cxf.osgi.cfg file (Please see +[http://team.ops4j.org/wiki//display/paxweb/Pax+Web](http://team.ops4j.org/wiki//display/paxweb/Pax+Web) for more information on PAX Web). + + [http://localhost:8181/cxf/camel-example-cxf-osgi/webservices/incident?wsdl](http://localhost:8181/cxf/camel-example-cxf-osgi/webservices/incident?wsdl) + + +#### Step 5: Start SOAPUI (2.x or later) +Create a new project called camel-example-cxf-osgi +Point to the following url: http://localhost:8181/cxf/camel-example-cxf-osgi/webservices/incident?wsdl +Open the request 1 (under camel-example-cxf-osgi --> ReportIncidentBinding --> ReportIncident) and copy/paste a SOAP +message generated by the unit test, for example: + + <xml version="1.0" encoding="UTF-8"?> + <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/";> + <soap:Header /> + <soap:Body> + <ns2:inputReportIncident xmlns:ns2="http://reportincident.example.camel.apache.org";> + <incidentId>111</incidentId> + <incidentDate>2011-03-05</incidentDate> + <givenName>Christian</givenName> + <familyName>Mueller</familyName> + <summary>Bla</summary> + <details>Bla bla</details> + <email>cmuel...@apache.org</email> + <phone>0049 69 1234567</phone> + </ns2:inputReportIncident> + </soap:Body> + </soap:Envelope> + + +#### Step 6: Check the file system +Check the folder `target/inbox/` in the Karaf base directory to see that a message has arrived. + +### Documentation + +This example is described in more detail at + [http://camel.apache.org/cxf-example-osgi.html](http://camel.apache.org/cxf-example-osgi.html) + +### Forum, Help, etc + +If you hit an problems please let us know on the Camel Forums + [http://camel.apache.org/discussion-forums.html](http://camel.apache.org/discussion-forums.html) + +Please help us make Apache Camel better - we appreciate any feedback you may +have. Enjoy! + +------------------------ +The Camel riders! \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/403089fa/examples/camel-example-cxf-osgi/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-cxf-osgi/README.txt b/examples/camel-example-cxf-osgi/README.txt deleted file mode 100644 index fb49213..0000000 --- a/examples/camel-example-cxf-osgi/README.txt +++ /dev/null @@ -1,100 +0,0 @@ -CXF OSGI Example -================ - -A simple example which receives web service calls (via a CXF consumer, using bean binding) -and writes these requests into the file system. It's not a very useful use case, but the goal -of this example is to show you how you can use the CXF consumer component in an OSGI -environment with the OSGI HTTP service. If your target container is Apache Karaf or Apache -ServiceMix, you can use PAX Web to setup and start an OSGI HTTP service. All Camel -bundles using a Camel CXF consumer can use this HTTP service without needing to start -individual Jetty instances. Another advantage is that all provided services can now share -the same port. - - -You will need to compile the example first: - mvn install - -Remarks: -- During the compilation phase, a unit test will be performed which simulates the - client calling the web service exposed by our camel/cxf route. -- In Eclipse, I have used the following option when starting the junit test case. This option tells - CXF that it must use log4j : -Dorg.apache.cxf.Logger=org.apache.cxf.common.logging.Log4jLogger - -To run the example on Apache ServiceMix 4.x or Apache Karaf 2.2.x - -1) launch the server -karaf.bat - -Note for Karaf 2.2.x: - a) edit the etc/jre.properties file to add the following packages to be exported - jre-1.6=, \ - com.sun.org.apache.xerces.internal.dom, \ - com.sun.org.apache.xerces.internal.jaxp, \ - - b) from the same file comment out the following exports already provided by the bundles - that will be imported next: javax.xml.bind*, javax.jws*, javax.xml.soap*, javax.xml.ws*, - javax.activation, javax.annotation, javax.xml.stream*. - - -2) Add features required -features:addUrl mvn:org.apache.camel.karaf/apache-camel/${version}/xml/features -features:install war -features:install cxf -features:install camel-spring -features:install camel-jaxb -features:install camel-cxf - - -3) Deploy the example -osgi:install -s mvn:org.apache.camel/camel-example-cxf-osgi/${version} - - -4) Verify that your service is available using the following url in the browser. -We assume you're using Karaf's default PAX Web configuration which uses -port 8181 for http. If you would like to use another port or https, change the configuration in -${KARAF_HOME}/etc/org.ops4j.pax.web.cfg. The immediate extension after the hostname and port ("cxf" in -the below URL) is configured via the org.apache.cxf.osgi.cfg file (Please see -http://team.ops4j.org/wiki//display/paxweb/Pax+Web for more information on PAX Web). - -http://localhost:8181/cxf/camel-example-cxf-osgi/webservices/incident?wsdl - - -5) Start SOAPUI (2.x or later) -Create a new project called camel-example-cxf-osgi -Point to the following url: http://localhost:8181/cxf/camel-example-cxf-osgi/webservices/incident?wsdl -Open the request 1 (under camel-example-cxf-osgi --> ReportIncidentBinding --> ReportIncident) and copy/paste a SOAP -message generated by the unit test, for example: - -<xml version="1.0" encoding="UTF-8"?> -<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/";> - <soap:Header /> - <soap:Body> - <ns2:inputReportIncident xmlns:ns2="http://reportincident.example.camel.apache.org";> - <incidentId>111</incidentId> - <incidentDate>2011-03-05</incidentDate> - <givenName>Christian</givenName> - <familyName>Mueller</familyName> - <summary>Bla</summary> - <details>Bla bla</details> - <email>cmuel...@apache.org</email> - <phone>0049 69 1234567</phone> - </ns2:inputReportIncident> - </soap:Body> -</soap:Envelope> - - -6) Check the file system -Check the folder "target/inbox/" in the Karaf base directory to see that a message has arrived. - - -This example is described in more detail at - http://camel.apache.org/cxf-example-osgi.html - -If you hit any problems please let us know on the Camel Forums - http://camel.apache.org/discussion-forums.html - -Please help us make Apache Camel better - we appreciate any feedback you may -have. Enjoy! - ------------------------- -The Camel Riders! http://git-wip-us.apache.org/repos/asf/camel/blob/403089fa/examples/camel-example-cxf-proxy/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-cxf-proxy/README.md b/examples/camel-example-cxf-proxy/README.md new file mode 100644 index 0000000..e1c9f37 --- /dev/null +++ b/examples/camel-example-cxf-proxy/README.md @@ -0,0 +1,63 @@ +# CXF WebService Proxy example + +### Introduction + +An example which proxies a real web service by a Camel application using the camel-cxf component + +### Build +You will need to compile this example first: + + mvn compile + +### Run + +To run the example type: + + mvn camel:run + +The proxied webservice is located at + + [http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident](http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident) + +The real webservice is located at + [http://localhost:<port 2>/real-webservice](http://localhost:<port 2>/real-webservice) + +The webservice WSDL is exposed at: + [http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident?wsdl](http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident?wsdl) + +Because we use dynamic port numbers, you have to check the console to get the used one. +To stop the example hit `ctrl + c` + +To make a SOAP call open soapUI or another SOAP query tool and create a new +project w/WSDL of [http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident?wsdl](http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident?wsdl). +Then make SOAP requests of this format: + + <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"; + xmlns:rep="http://reportincident.example.camel.apache.org";> + <soapenv:Header/> + <soapenv:Body> + <rep:inputReportIncident> + <incidentId></incidentId> + <incidentDate>2011-11-18</incidentDate> + <givenName>Bob</givenName> + <familyName>Smith</familyName> + <summary>Bla bla</summary> + <details>More bla</details> + <email>y...@email.org</email> + <phone>12345678</phone> + </rep:inputReportIncident> + </soapenv:Body> + </soapenv:Envelope> + +This example is documented at [http://camel.apache.org/cxf-proxy-example.html](http://camel.apache.org/cxf-proxy-example.html) + +### Forum, Help, etc + +If you hit an problems please let us know on the Camel Forums + [http://camel.apache.org/discussion-forums.html](http://camel.apache.org/discussion-forums.html) + +Please help us make Apache Camel better - we appreciate any feedback you may +have. Enjoy! + +------------------------ +The Camel riders! \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/403089fa/examples/camel-example-cxf-proxy/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-cxf-proxy/README.txt b/examples/camel-example-cxf-proxy/README.txt deleted file mode 100644 index bdee92f..0000000 --- a/examples/camel-example-cxf-proxy/README.txt +++ /dev/null @@ -1,55 +0,0 @@ -CXF WebService Proxy example -============================ - -An example which proxies a real web service by a Camel application using the camel-cxf component - -You will need to compile this example first: - mvn compile - -To run the example type: - mvn camel:run - -The proxied webservice is located at - http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident - -The real webservice is located at - http://localhost:<port 2>/real-webservice - -The webservice WSDL is exposed at: - http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident?wsdl - -Because we use dynamic port numbers, you have to check the console to get the used one. -To stop the example hit ctrl + c - -To make a SOAP call open soapUI or another SOAP query tool and create a new -project w/WSDL of http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident?wsdl. -Then make SOAP requests of this format: - -<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"; - xmlns:rep="http://reportincident.example.camel.apache.org";> - <soapenv:Header/> - <soapenv:Body> - <rep:inputReportIncident> - <incidentId></incidentId> - <incidentDate>2011-11-18</incidentDate> - <givenName>Bob</givenName> - <familyName>Smith</familyName> - <summary>Bla bla</summary> - <details>More bla</details> - <email>davscl...@apache.org</email> - <phone>12345678</phone> - </rep:inputReportIncident> - </soapenv:Body> -</soapenv:Envelope> - -This example is documented at - http://camel.apache.org/cxf-proxy-example.html - -If you hit any problems please let us know on the Camel Forums - http://camel.apache.org/discussion-forums.html - -Please help us make Apache Camel better - we appreciate any feedback you may -have. Enjoy! - ------------------------- -The Camel Riders!
