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/f9f54c10 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f9f54c10 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f9f54c10 Branch: refs/heads/master Commit: f9f54c10c89c989f87a0c74070f489d0f16b4c68 Parents: 9d82e26 Author: gautric <gaut...@redhat.com> Authored: Wed Dec 9 19:40:04 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Thu Dec 10 07:45:00 2015 +0100 ---------------------------------------------------------------------- examples/camel-example-cxf-blueprint/README.md | 4 +- examples/camel-example-cxf-osgi/README.md | 5 +- examples/camel-example-cxf-proxy/README.md | 14 ++++-- examples/camel-example-cxf-tomcat/README.md | 4 +- examples/camel-example-ftp/README.md | 54 +++++++++++++++++++++ examples/camel-example-ftp/README.txt | 42 ---------------- examples/camel-example-gae/README.md | 16 ++++++ examples/camel-example-gae/README.txt | 13 ----- 8 files changed, 90 insertions(+), 62 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/f9f54c10/examples/camel-example-cxf-blueprint/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-cxf-blueprint/README.md b/examples/camel-example-cxf-blueprint/README.md index 21d907e..ae14ea7 100644 --- a/examples/camel-example-cxf-blueprint/README.md +++ b/examples/camel-example-cxf-blueprint/README.md @@ -46,7 +46,9 @@ Deploy the example 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-blueprint/webservices/incident?wsdl](http://localhost:8181/cxf/camel-example-cxf-blueprint/webservices/incident?wsdl) + http://localhost:8181/cxf/camel-example-cxf-blueprint/webservices/incident?wsdl + +[http://localhost:8181/cxf/camel-example-cxf-blueprint/webservices/incident?wsdl](http://localhost:8181/cxf/camel-example-cxf-blueprint/webservices/incident?wsdl) #### Step 5: Start SOAPUI (2.x or later) http://git-wip-us.apache.org/repos/asf/camel/blob/f9f54c10/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 index 383c254..3853c15 100644 --- a/examples/camel-example-cxf-osgi/README.md +++ b/examples/camel-example-cxf-osgi/README.md @@ -1,5 +1,4 @@ # CXF OSGI Example -================ ### Introduction @@ -63,7 +62,9 @@ port `8181` for http. If you would like to use another port or https, change the 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) + http://localhost:8181/cxf/camel-example-cxf-osgi/webservices/incident?wsdl + +[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) http://git-wip-us.apache.org/repos/asf/camel/blob/f9f54c10/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 index bd16e37..66daca1 100644 --- a/examples/camel-example-cxf-proxy/README.md +++ b/examples/camel-example-cxf-proxy/README.md @@ -17,13 +17,21 @@ To run the example type: 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) + http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident + +[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) + + http://localhost:<port 2>/real-webservice + +[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) + + http://localhost:<port 1>/camel-example-cxf-proxy/webservices/incident?wsdl + +[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` http://git-wip-us.apache.org/repos/asf/camel/blob/f9f54c10/examples/camel-example-cxf-tomcat/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-cxf-tomcat/README.md b/examples/camel-example-cxf-tomcat/README.md index b2e4abe..ca99a9b 100644 --- a/examples/camel-example-cxf-tomcat/README.md +++ b/examples/camel-example-cxf-tomcat/README.md @@ -22,7 +22,9 @@ to install the WAR file. The webservice is located at - [http://localhost:8080/camel-example-cxf-tomcat/webservices/incident?wsdl](http://localhost:8080/camel-example-cxf-tomcat/webservices/incident?wsdl) + http://localhost:8080/camel-example-cxf-tomcat/webservices/incident?wsdl + +[http://localhost:8080/camel-example-cxf-tomcat/webservices/incident?wsdl](http://localhost:8080/camel-example-cxf-tomcat/webservices/incident?wsdl) You can run a sample client using the "mvn exec:java" command, or, within soapUI, making sample SOAP requests such as the following: http://git-wip-us.apache.org/repos/asf/camel/blob/f9f54c10/examples/camel-example-ftp/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-ftp/README.md b/examples/camel-example-ftp/README.md new file mode 100644 index 0000000..c5be626 --- /dev/null +++ b/examples/camel-example-ftp/README.md @@ -0,0 +1,54 @@ +# Camel FTP example + +### Introduction + +An example which shows how to integrate Camel with an FTP server. + +This example requires that an existing FTP server is available. +You can configure the location of this FTP server in the file: + `src/main/resources/ftp.properties` + +### Build + +You will need to compile this example first: + + mvn compile + +### Run + +This example can either run as a Camel client or server. + +* The client will upload files from the `target/upload` directory + to the FTP server. + +* The server will download files from the FTP server to the local + file system in the `target/download` directory. + +To run the client you type: + + mvn compile exec:java -Pclient + +... and instructions will be printed on the console. + +To run the server you type: + + mvn compile exec:java -Pserver + +... and instructions will be printed on the console. + + +### Documentation + +This example is documented at [http://camel.apache.org/ftp-example.html](http://camel.apache.org/ftp-example.html) + +You can enable verbose logging by adjustung the `src/main/resources/log4j.properties` file as documented in the file. + +### 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! http://git-wip-us.apache.org/repos/asf/camel/blob/f9f54c10/examples/camel-example-ftp/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-ftp/README.txt b/examples/camel-example-ftp/README.txt deleted file mode 100644 index f9d09cf..0000000 --- a/examples/camel-example-ftp/README.txt +++ /dev/null @@ -1,42 +0,0 @@ -Camel FTP example -================= - -An example which shows how to integrate Camel with an FTP server. - -This example requires that an existing FTP server is available. -You can configure the location of this FTP server in the file: - src/main/resources/ftp.properties - -You will need to compile this example first: - mvn compile - -This example can either run as a Camel client or server. - -* The client will upload files from the target/upload directory - to the FTP server. - -* The server will download files from the FTP server to the local - file system in the target/download directory. - -To run the client you type: - mvn compile exec:java -Pclient -... and instructions will be printed on the console. - -To run the server you type: - mvn compile exec:java -Pserver -... and instructions will be printed on the console. - -This example is documented at - http://camel.apache.org/ftp-example.html - -You can enable verbose logging by adjustung the src/main/resources/log4j.properties - file as documented in the file. - -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/f9f54c10/examples/camel-example-gae/README.md ---------------------------------------------------------------------- diff --git a/examples/camel-example-gae/README.md b/examples/camel-example-gae/README.md new file mode 100644 index 0000000..df53e02 --- /dev/null +++ b/examples/camel-example-gae/README.md @@ -0,0 +1,16 @@ +# GAE Example + +### Introduction + +Building, deplyoing and running this example is described in detail at +[http://camel.apache.org/tutorial-for-camel-on-google-app-engine.html](http://camel.apache.org/tutorial-for-camel-on-google-app-engine.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! http://git-wip-us.apache.org/repos/asf/camel/blob/f9f54c10/examples/camel-example-gae/README.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-gae/README.txt b/examples/camel-example-gae/README.txt deleted file mode 100644 index e33312e..0000000 --- a/examples/camel-example-gae/README.txt +++ /dev/null @@ -1,13 +0,0 @@ -GAE Example -=========== - -Building, deplyoing and running this example is described in detail at -http://camel.apache.org/tutorial-for-camel-on-google-app-engine.html - -Please help us make Apache Camel better - we appreciate any feedback you -may have. - -Enjoy! - ------------------------- -The Camel riders!
