You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2015/12/10 15:54:05 UTC
[1/2] camel git commit: CAMEL-9337 Add readme.txt to all examples
Repository: camel
Updated Branches:
refs/heads/master 4e43476ae -> 149648b20
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-sql/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-sql/README.md b/examples/camel-example-sql/README.md
new file mode 100644
index 0000000..b7c1f04
--- /dev/null
+++ b/examples/camel-example-sql/README.md
@@ -0,0 +1,71 @@
+# Camel SQL Example
+
+### Introduction
+This example shows how to exchange data using a shared database table.
+
+The example has two Camel routes. The first route insert new data into the table,
+triggered by a timer to run every 5th second.
+
+The second route pickup the newly inserted rows from the table,
+process the row(s), and mark the row(s) as processed when done;
+to avoid picking up the same rows again.
+
+### Build
+
+You will need to compile this example first:
+
+ mvn install
+
+### Run with maven
+
+To run the example type
+
+ mvn camel:run
+
+To stop the example hit `ctrl + c`
+
+This example uses Spring to setup and configure the database,
+as well the CamelContext. You can see this in the following file:
+In the src/main/resources/META-INF/spring/camel-context.xml
+
+### Run with Karaf
+
+To install Apache Camel in Karaf you type in the shell (we use version ${project.version}):
+
+ features:chooseurl camel ${project.version}
+ features:install camel
+
+First you need to install the following features in Karaf/ServiceMix with:
+
+ features:install camel-spring
+ features:install camel-sql
+
+Then you need to install JDBC connection pool and the Derby Database:
+
+ osgi:install -s mvn:commons-pool/commons-pool/1.6
+ osgi:install -s mvn:commons-dbcp/commons-dbcp/1.4
+ osgi:install -s mvn:org.apache.derby/derby/10.10.1.1
+
+Then you can install the Camel example:
+
+ osgi:install -s mvn:org.apache.camel/camel-example-sql/${project.version}
+
+And you can see the application running by tailing the logs
+
+ log:tail
+
+And you can use `ctrl + c` to stop tailing the log.
+
+### Documentation
+This example is documented at <http://camel.apache.org/sql-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>
+
+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/149648b2/examples/camel-example-sql/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-sql/README.txt b/examples/camel-example-sql/README.txt
deleted file mode 100644
index 83087e1..0000000
--- a/examples/camel-example-sql/README.txt
+++ /dev/null
@@ -1,68 +0,0 @@
-Camel SQL Example
-=================
-
-This example shows how to exchange data using a shared database table.
-
-The example has two Camel routes. The first route insert new data into the table,
-triggered by a timer to run every 5th second.
-
-The second route pickup the newly inserted rows from the table,
-process the row(s), and mark the row(s) as processed when done;
-to avoid picking up the same rows again.
-
-Standalone
-----------
-You will need to compile this example first:
- mvn compile
-
-To run the example type
- mvn camel:run
-
-To stop the example hit ctrl + c
-
-This example uses Spring to setup and configure the database,
-as well the CamelContext. You can see this in the following file:
-In the src/main/resources/META-INF/spring/camel-context.xml
-
-Apache Karaf / ServiceMix
--------------------------
-You will need to compile this example first:
- mvn compile
-
-To install Apache Camel in Karaf you type in the shell (we use version ${project.version}):
-
- features:chooseurl camel ${project.version}
- features:install camel
-
-First you need to install the following features in Karaf/ServiceMix with:
-
- features:install camel-spring
- features:install camel-sql
-
-Then you need to install JDBC connection pool and the Derby Database:
-
- osgi:install -s mvn:commons-pool/commons-pool/1.6
- osgi:install -s mvn:commons-dbcp/commons-dbcp/1.4
- osgi:install -s mvn:org.apache.derby/derby/10.10.1.1
-
-Then you can install the Camel example:
-
- osgi:install -s mvn:org.apache.camel/camel-example-sql/${project.version}
-
-And you can see the application running by tailing the logs
-
- log:tail
-
-And you can use ctrl + c to stop tailing the log.
-
-This example is documented at
- http://camel.apache.org/sql-example.html
-
-If you hit any problems please talk to us 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/149648b2/examples/camel-example-ssh-security/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-ssh-security/README.md b/examples/camel-example-ssh-security/README.md
new file mode 100644
index 0000000..fb58d7c
--- /dev/null
+++ b/examples/camel-example-ssh-security/README.md
@@ -0,0 +1,99 @@
+# Camel-SSH using Key Example
+
+### Introduction
+This examples shows how to use the Camel-SSH component to call Apache Karaf
+using Public Key versus password. It can be run using Maven.
+
+### Requirements
+
+* [Apache Maven](http://maven.apache.org) version 3.x
+* [Apache Karaf](http://karaf.apache.org) version 2.3.1
+
+### Setup Karaf
+
+We will need to make 2 changes to Karaf for this example to work.
+
+1. Register the Bouncy Castle Java Cryptography Extension (JCE) with Karaf.
+2. Add a user and public key to Karaf's identity store.
+
+#### Register Bouncy Castle
+
+We need the Bouncy Castle JCE as Karaf's included Mina SSHD server uses this to handle Public Key files.
+
+Install the following jars into the `<karaf_home>/lib/ext` directory.
+
+ curl -O http://downloads.bouncycastle.org/java/bcprov-jdk15on-147.jar
+ curl -O http://downloads.bouncycastle.org/java/bcprov-ext-jdk15on-147.jar
+ curl -O http://downloads.bouncycastle.org/java/bcpkix-jdk15on-147.jar
+
+Edit the `<karaf_home>/etc/config.properties` file, making 2 changes
+
+1. add the following line
+
+ org.apache.karaf.security.providers = org.bouncycastle.jce.provider.BouncyCastleProvider
+
+2. update the `org.osgi.framework.bootdelegation` property, appending `,org.bouncycastle.*` to the end. It should look
+something like the following when done
+
+ org.osgi.framework.bootdelegation=org.apache.karaf.jaas.boot,sun.*,com.sun.*,javax.transaction,javax.transaction.*,org.bouncycastle.*
+
+#### Add a user and public key
+
+Edit the `<karaf_home>/etc/keys.properties` file, appending a new user `scott`. The format of the keys.properties
+file is as follows
+
+ <user name>=<public key>,<role>
+
+For this example you will need to add a new user `scott` with the key value from the included
+`src/main/resources/test_rsa.pub` file. The included Camel route uses the associated private key
+`src/main/resources/test_rsa` when connecting to the updated Karaf server.
+
+Append the following to the `<karaf_home>/etc/keys.properties` file
+
+ scott=AAAAB3NzaC1yc2EAAAADAQABAAABAQC4MSqXneGVM9n3Rnqfya0D31crTx+J8X8dKZ5/+2Rq96/klnmt6uGyl+DI8G0HXVK66KqU2Z0qUE9ytOMR+zSPA+zU4Bhd3G82qdJsys7Nz8t9wSWQs8/ItWTjwg+b3vVLcI1Q8sSgfxqZvD/XQk4srbDs9ba55yjEPn5DOhA7UFbFAv8menSgbpNFMrUQQ9DJcMVlu3MOcMylI5UFFf1uvDD3vUoFXZa6GQOK9j1AGvfagGgBEqV4/AiKzDmQDFqMzmTfTfBpi1crY0SGXdT26PE4Knx7KP7bBJupBm6lJ9Pk39iw8dnDWcq45EEqrHsI0dps7/iQgYxYqBmFLIkP,admin
+
+
+
+### Build
+
+To build, run the following command
+
+ mvn clean install
+
+### Run with maven
+To test locally, assuming you have Setup Karaf and have it running, run the following command
+
+ mvn camel:run
+
+To stop the example hit `ctrl + c`
+
+### Run with Karaf
+
+Karaf should be all configured at this point so start up an instance by running the `bin/karaf` from
+the `<karaf_home>` directory.
+
+ karaf
+
+
+From the running Karaf console, run the following commands to install this example into your
+running Karaf server.
+
+ features:addurl mvn:org.apache.camel/camel-example-ssh-security/<camel version>/xml/features
+ features:install camel-example-ssh-security
+
+This example outputs into the Karaf log file so you can either `tail -f <karaf_home>data/log/karaf.log`
+or from the Karaf console run the following command
+
+ log:tail
+
+### Forum, Help, etc
+
+If you hit an 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/149648b2/examples/camel-example-ssh-security/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-ssh-security/README.txt b/examples/camel-example-ssh-security/README.txt
deleted file mode 100644
index b3b244c..0000000
--- a/examples/camel-example-ssh-security/README.txt
+++ /dev/null
@@ -1,96 +0,0 @@
-Camel-SSH using Key Example
-===========================
-
-This examples shows how to use the Camel-SSH component to call Apache Karaf
-using Public Key versus password. It can be run using Maven.
-
-Requirements
-------------
-
-* [Apache Maven](http://maven.apache.org) version 3.x
-* [Apache Karaf](http://karaf.apache.org) version 2.3.1
-
-Setup Karaf
------------
-
-We will need to make 2 changes to Karaf for this example to work.
-
-1. Register the Bouncy Castle Java Cryptography Extension (JCE) with Karaf.
-2. Add a user and public key to Karaf's identity store.
-
-### Register Bouncy Castle
-
-We need the Bouncy Castle JCE as Karaf's included Mina SSHD server uses this to handle Public Key files.
-
-Install the following jars into the `<karaf_home>/lib/ext` directory.
-
- curl -O http://downloads.bouncycastle.org/java/bcprov-jdk15on-147.jar
- curl -O http://downloads.bouncycastle.org/java/bcprov-ext-jdk15on-147.jar
- curl -O http://downloads.bouncycastle.org/java/bcpkix-jdk15on-147.jar
-
-Edit the `<karaf_home>/etc/config.properties` file, making 2 changes
-
-1. add the following line
-
- org.apache.karaf.security.providers = org.bouncycastle.jce.provider.BouncyCastleProvider
-
-2. update the `org.osgi.framework.bootdelegation` property, appending `,org.bouncycastle.*` to the end. It should look
-something like the following when done
-
- org.osgi.framework.bootdelegation=org.apache.karaf.jaas.boot,sun.*,com.sun.*,javax.transaction,javax.transaction.*,org.bouncycastle.*
-
-### Add a user and public key
-
-Edit the `<karaf_home>/etc/keys.properties` file, appending a new user `scott`. The format of the keys.properties
-file is as follows
-
- <user name>=<public key>,<role>
-
-For this example you will need to add a new user `scott` with the key value from the included
-`src/main/resources/test_rsa.pub` file. The included Camel route uses the associated private key
-`src/main/resources/test_rsa` when connecting to the updated Karaf server.
-
-Append the following to the `<karaf_home>/etc/keys.properties` file
-
- scott=AAAAB3NzaC1yc2EAAAADAQABAAABAQC4MSqXneGVM9n3Rnqfya0D31crTx+J8X8dKZ5/+2Rq96/klnmt6uGyl+DI8G0HXVK66KqU2Z0qUE9ytOMR+zSPA+zU4Bhd3G82qdJsys7Nz8t9wSWQs8/ItWTjwg+b3vVLcI1Q8sSgfxqZvD/XQk4srbDs9ba55yjEPn5DOhA7UFbFAv8menSgbpNFMrUQQ9DJcMVlu3MOcMylI5UFFf1uvDD3vUoFXZa6GQOK9j1AGvfagGgBEqV4/AiKzDmQDFqMzmTfTfBpi1crY0SGXdT26PE4Knx7KP7bBJupBm6lJ9Pk39iw8dnDWcq45EEqrHsI0dps7/iQgYxYqBmFLIkP,admin
-
-### Start Karaf
-
-Karaf should be all configured at this point so start up an instance by running the `bin/karaf` from
-the `<karaf_home>` directory.
-
-Building this example
----------------------
-
-To build, run the following command
-
- mvn clean install
-
-To test locally, assuming you have Setup Karaf and have it running, run the following command
-
- mvn camel:run
-
-To stop the example hit ctrl + c
-
-Deploy to Karaf
----------------
-
-From the running Karaf console, run the following commands to install this example into your
-running Karaf server.
-
- features:addurl mvn:org.apache.camel/camel-example-ssh-security/<camel version>/xml/features
- features:install camel-example-ssh-security
-
-This example outputs into the Karaf log file so you can either `tail -f <karaf_home>data/log/karaf.log`
-or from the Karaf console run the following command
-
- log:tail
-
-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/149648b2/examples/camel-example-ssh/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-ssh/README.md b/examples/camel-example-ssh/README.md
new file mode 100644
index 0000000..61a2b42
--- /dev/null
+++ b/examples/camel-example-ssh/README.md
@@ -0,0 +1,39 @@
+# SSH Example
+
+### Introduction
+This example shows how use SSH with Camel. It can be run using Maven.
+
+This example is built assuming you have a running Apache ServiceMix container with the default SSH port `8101` and
+username / password of smx/smx.
+
+### Build
+You will need to compile this example first:
+
+ mvn install
+
+### Run with maven
+To run the example using Maven type
+
+ mvn camel:run
+
+To stop the example hit `ctrl + c`
+
+### Run with Karaf
+
+If using Apache Karaf / Apache ServiceMix you can install this example
+from the shell
+
+ features:chooseurl camel <camel version>
+ features:addurl mvn:org.apache.camel/camel-example-ssh/<camel version>/xml/features
+ features:install camel-example-ssh
+
+### Forum, Help, etc
+
+If you hit an 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/149648b2/examples/camel-example-ssh/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-ssh/README.txt b/examples/camel-example-ssh/README.txt
deleted file mode 100644
index 44847e1..0000000
--- a/examples/camel-example-ssh/README.txt
+++ /dev/null
@@ -1,42 +0,0 @@
-SSH Example
-=====================
-
-This example shows how use SSH with Camel. It can be run using Maven.
-
-This example is built assuming you have a running Apache ServiceMix container with the default SSH port 8101 and
-username / password of smx/smx.
-
-Running from cmd line outside OSGi container
-============================================
-
-You will need to compile this example first:
- mvn compile
-
-To run the example using Maven type
- mvn camel:run
-
-To stop the example hit ctrl + c
-
-
-
-Running inside OSGi container
-=============================
-
-You will need to compile and install this example first:
- mvn compile install
-
-If using Apache Karaf / Apache ServiceMix you can install this example
-from the shell
-
- features:chooseurl camel <camel version>
- features:addurl mvn:org.apache.camel/camel-example-ssh/<camel version>/xml/features
- features:install camel-example-ssh
-
-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/149648b2/examples/camel-example-swagger-cdi/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-cdi/README.md b/examples/camel-example-swagger-cdi/README.md
new file mode 100644
index 0000000..d9d3f19
--- /dev/null
+++ b/examples/camel-example-swagger-cdi/README.md
@@ -0,0 +1,46 @@
+# Camel Swagger cdi Example
+
+### Introduction
+This is an example that uses the rest-dsl to define a rest services which provides three operations
+
+- GET user/{id} - Find user by id
+- PUT user - Updates or create a user
+- GET user/findAll - Find all users
+
+
+
+### Build
+You will need to compile this example first:
+ mvn compile
+
+### Run
+To run the example type
+ mvn camel:run
+
+The rest service can be accessed from the following url
+
+ curl http://localhost:8080/user
+<http://localhost:8080/user>
+
+For example to get a user with id 123
+
+ curl http://localhost:8080/user/123
+<http://localhost:8080/user/123>
+
+The rest services provides Swagger API which can be accessed from the following url
+
+ http://localhost:8080/api-docs
+<http://localhost:8080/api-docs>
+
+To stop the example hit `ctrl + c`
+
+### Forum, Help, etc
+
+If you hit an 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/149648b2/examples/camel-example-swagger-cdi/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-cdi/README.txt b/examples/camel-example-swagger-cdi/README.txt
deleted file mode 100644
index 7e5fcba..0000000
--- a/examples/camel-example-swagger-cdi/README.txt
+++ /dev/null
@@ -1,38 +0,0 @@
-camel-example-swagger-cdi
-=========================
-
-This is an example that uses the rest-dsl to define a rest services which provides three operations
-
-- GET user/{id} - Find user by id
-- PUT user - Updates or create a user
-- GET user/findAll - Find all users
-
-The rest service can be accessed from the following url
-
- http://localhost:8080/user
-
-For example to get a user with id 123
-
- http://localhost:8080/user/123
-
-The rest services provides Swagger API which can be accessed from the following url
-
- http://localhost:8080/api-docs
-
-
-You will need to compile this example first:
- mvn compile
-
-To run the example type
- mvn camel:run
-
-To stop the example hit ctrl + c
-
-If you hit any problems please talk to us 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/149648b2/examples/camel-example-swagger-java/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/README.md b/examples/camel-example-swagger-java/README.md
new file mode 100644
index 0000000..38a0d4c
--- /dev/null
+++ b/examples/camel-example-swagger-java/README.md
@@ -0,0 +1,44 @@
+# Camel Swagger Java example
+
+### Introduction
+This is an example that uses the rest-dsl to define a rest services which provides three operations
+
+- GET user/{id} - Find user by id
+- PUT user - Updates or create a user
+- GET user/findAll - Find all users
+
+The example also embeds the swagger ui.
+
+### Build
+You will need to compile this example first:
+
+ mvn compile
+
+### Compile
+To run the example type
+
+ mvn jetty:run
+
+The example is built as a WAR which can also be deployed in a WAR container such as Apache Tomcat.
+
+The example has documentation in the home.html page which you can access using the following url
+
+ http://localhost:8080/camel-example-swagger-java/
+
+<http://localhost:8080/camel-example-swagger-java/>
+
+This example implements the rest-dsl in XML in the camel-config.xml file. For an example that
+is using Java code, see the `camel-example-swagger-cdi`.
+
+To stop the example hit `ctrl + c`
+
+### Forum, Help, etc
+
+If you hit an 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/149648b2/examples/camel-example-swagger-java/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/README.txt b/examples/camel-example-swagger-java/README.txt
deleted file mode 100644
index df8ccd6..0000000
--- a/examples/camel-example-swagger-java/README.txt
+++ /dev/null
@@ -1,36 +0,0 @@
-camel-example-swagger-java
-==========================
-
-This is an example that uses the rest-dsl to define a rest services which provides three operations
-
-- GET user/{id} - Find user by id
-- PUT user - Updates or create a user
-- GET user/findAll - Find all users
-
-The example also embeds the swagger ui.
-
-You will need to compile this example first:
- mvn compile
-
-To run the example type
- mvn jetty:run
-
-The example is built as a WAR which can also be deployed in a WAR container such as Apache Tomcat.
-
-The example has documentation in the home.html page which you can access using the following url
-
- http://localhost:8080/camel-example-swagger-java/
-
-This example implements the rest-dsl in XML in the camel-config.xml file. For an example that
-is using Java code, see the camel-example-swagger-cdi.
-
-To stop the example hit ctrl + c
-
-If you hit any problems please talk to us 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/149648b2/examples/camel-example-tracer/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-tracer/README.md b/examples/camel-example-tracer/README.md
new file mode 100644
index 0000000..52a8009
--- /dev/null
+++ b/examples/camel-example-tracer/README.md
@@ -0,0 +1,45 @@
+# Tracer Example
+
+### Introduction
+This example shows how to persist Camel trace event messages into a database using JPA.
+
+### Build
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+
+To run the example with Maven, type
+
+ mvn camel:run
+
+In the console you can enter some words separated with space. Try to enter:
+
+ nice beer
+ beer whiskey
+ camel nice day
+
+This example will based on the input get some quotes from the input and select the best quote
+to return as response in the console.
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+
+For a background in tracer and JPA see
+ http://camel.apache.org/tracer.html
+ http://camel.apache.org/jpa.html
+
+This example is documented at <http://camel.apache.org/tracer-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>
+
+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/149648b2/examples/camel-example-tracer/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-tracer/README.txt b/examples/camel-example-tracer/README.txt
deleted file mode 100644
index f3e6bf4..0000000
--- a/examples/camel-example-tracer/README.txt
+++ /dev/null
@@ -1,36 +0,0 @@
-Tracer Example
-==============
-
-This example shows how to persist Camel trace event messages into a database using JPA.
-
-You will need to compile this example first:
- mvn compile
-
-For a background in tracer and JPA see
- http://camel.apache.org/tracer.html
- http://camel.apache.org/jpa.html
-
-To run the example with Maven, type
- mvn camel:run
-
-In the console you can enter some words separated with space. Try to enter:
- nice beer
- beer whiskey
- camel nice day
-
-This example will based on the input get some quotes from the input and select the best quote
-to return as response in the console.
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/tracer-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!
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-twitter-websocket-blueprint/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-twitter-websocket-blueprint/README.md b/examples/camel-example-twitter-websocket-blueprint/README.md
new file mode 100644
index 0000000..cd8c969
--- /dev/null
+++ b/examples/camel-example-twitter-websocket-blueprint/README.md
@@ -0,0 +1,63 @@
+# Twitter and Websocket Blueprint Example
+
+### Introduction
+The example is demonstrating how to poll a constant feed of twitter searches
+and publish results in real time using web socket to a web page.
+
+This example is already configured using a testing purpose twitter account named 'cameltweet'.
+And therefore the example is ready to run out of the box.
+
+This account is only for testing purpose, and should not be used in your custom applications.
+For that you need to setup and use your own twitter account.
+
+### Build
+You will need to install this example first to your local maven repository with:
+ mvn install
+
+### Run with Karaf
+This example requires running in Apache Karaf / ServiceMix
+
+ karaf
+
+To install Apache Camel in Karaf you type in the shell (as an example here we make use of
+Camel version 2.12.0):
+
+ features:chooseurl camel 2.12.0
+
+First you need to install the following features in Karaf/ServiceMix with:
+
+ features:install camel-blueprint
+ features:install camel-twitter
+ features:install camel-websocket
+
+Then you can install the Camel example:
+
+ osgi:install -s mvn:org.apache.camel/camel-example-twitter-websocket-blueprint/2.12.0
+
+Then open a browser to see live twitter updates in the web page
+
+ http://localhost:9090
+<http://localhost:9090>
+To stop the example run from Karaf/ServiceMix shell:
+ stop <bundle id>
+
+eg if the bundle id is 99 then type:
+ stop 99
+
+### Documentation
+We have described this in more details at the Camel twitter documentation: <http://camel.apache.org/twitter>
+
+This example is documented at <http://camel.apache.org/twitter-websocket-blueprint-example.html>
+
+There is a regular (non OSGi Blueprint) example as well documented at: <http://camel.apache.org/twitter-websocket-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>
+
+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/149648b2/examples/camel-example-twitter-websocket-blueprint/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-twitter-websocket-blueprint/README.txt b/examples/camel-example-twitter-websocket-blueprint/README.txt
deleted file mode 100644
index 918d314..0000000
--- a/examples/camel-example-twitter-websocket-blueprint/README.txt
+++ /dev/null
@@ -1,58 +0,0 @@
-Twitter and Websocket Blueprint Example
-=======================================
-
-The example is demonstrating how to poll a constant feed of twitter searches
-and publish results in real time using web socket to a web page.
-
-This example is already configured using a testing purpose twitter account named 'cameltweet'.
-And therefore the example is ready to run out of the box.
-
-This account is only for testing purpose, and should not be used in your custom applications.
-For that you need to setup and use your own twitter account.
-
-We have described this in more details at the Camel twitter documentation:
- http://camel.apache.org/twitter
-
-You will need to install this example first to your local maven repository with:
- mvn install
-
-This example requires running in Apache Karaf / ServiceMix
-
-To install Apache Camel in Karaf you type in the shell (as an example here we make use of
-Camel version 2.12.0):
-
- features:chooseurl camel 2.12.0
-
-First you need to install the following features in Karaf/ServiceMix with:
-
- features:install camel-blueprint
- features:install camel-twitter
- features:install camel-websocket
-
-Then you can install the Camel example:
-
- osgi:install -s mvn:org.apache.camel/camel-example-twitter-websocket-blueprint/2.12.0
-
-Then open a browser to see live twitter updates in the web page
- http://localhost:9090
-
-To stop the example run from Karaf/ServiceMix shell:
- stop <bundle id>
-
-eg if the bundle id is 99 then type:
- stop 99
-
-This example is documented at
- http://camel.apache.org/twitter-websocket-blueprint-example.html
-
-There is a regular (non OSGi Blueprint) example as well documented at:
- http://camel.apache.org/twitter-websocket-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!
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-twitter-websocket/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-twitter-websocket/README.md b/examples/camel-example-twitter-websocket/README.md
new file mode 100644
index 0000000..42854d2
--- /dev/null
+++ b/examples/camel-example-twitter-websocket/README.md
@@ -0,0 +1,45 @@
+# Twitter and Websocket Example
+
+### Introduction
+The example is demonstrating how to poll a constant feed of twitter searches
+and publish results in real time using web socket to a web page.
+
+This example is already configured using a testing purpose twitter account named 'cameltweet'.
+And therefore the example is ready to run out of the box.
+
+This account is only for testing purpose, and should not be used in your custom applications.
+For that you need to setup and use your own twitter account.
+
+### Build
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+To run the example type
+
+ mvn camel:run
+
+Then open a browser to see live twitter updates in the web page
+
+ http://localhost:9090
+<http://localhost:9090>
+
+To stop the example hit `ctrl + c`
+
+
+### Documentation
+We have described this in more details at the Camel twitter documentation: <http://camel.apache.org/twitter>
+
+This example is documented at <http://camel.apache.org/twitter-websocket-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>
+
+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/149648b2/examples/camel-example-twitter-websocket/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-twitter-websocket/README.txt b/examples/camel-example-twitter-websocket/README.txt
deleted file mode 100644
index 0319d10..0000000
--- a/examples/camel-example-twitter-websocket/README.txt
+++ /dev/null
@@ -1,37 +0,0 @@
-Twitter and Websocket Example
-=============================
-
-The example is demonstrating how to poll a constant feed of twitter searches
-and publish results in real time using web socket to a web page.
-
-This example is already configured using a testing purpose twitter account named 'cameltweet'.
-And therefore the example is ready to run out of the box.
-
-This account is only for testing purpose, and should not be used in your custom applications.
-For that you need to setup and use your own twitter account.
-
-We have described this in more details at the Camel twitter documentation:
- http://camel.apache.org/twitter
-
-You will need to compile this example first:
- mvn compile
-
-To run the example type
- mvn camel:run
-
-Then open a browser to see live twitter updates in the web page
- http://localhost:9090
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/twitter-websocket-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!
[2/2] camel git commit: CAMEL-9337 Add readme.txt to all examples
Posted by da...@apache.org.
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/149648b2
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/149648b2
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/149648b2
Branch: refs/heads/master
Commit: 149648b204c18d6ef96abe57115772c9db4107c6
Parents: 4e43476
Author: gautric <ga...@redhat.com>
Authored: Thu Dec 10 15:47:25 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Dec 10 15:53:02 2015 +0100
----------------------------------------------------------------------
examples/camel-example-bam/README.md | 21 ++-
examples/camel-example-etl/README.md | 13 +-
examples/camel-example-pojo-messaging/README.md | 33 +++++
.../camel-example-pojo-messaging/README.txt | 23 ----
.../README.md | 131 +++++++++++++++++++
.../README.txt | 119 -----------------
examples/camel-example-reportincident/README.md | 43 ++++++
.../camel-example-reportincident/README.txt | 31 -----
examples/camel-example-restlet-jdbc/README.md | 58 ++++++++
examples/camel-example-restlet-jdbc/README.txt | 38 ------
.../camel-example-route-throttling/README.md | 48 +++++++
.../camel-example-route-throttling/README.txt | 42 ------
.../README.md | 66 ++++++++++
.../README.txt | 63 ---------
.../camel-example-servlet-rest-tomcat/README.md | 1 +
.../README.txt | 1 -
.../README.md | 39 ++++++
.../README.txt | 30 -----
examples/camel-example-servlet-tomcat/README.md | 39 ++++++
.../camel-example-servlet-tomcat/README.txt | 29 ----
examples/camel-example-simplejirabot/README.md | 47 +++++++
examples/camel-example-simplejirabot/README.txt | 38 ------
.../camel-example-spark-rest-tomcat/README.md | 42 ++++++
.../camel-example-spark-rest-tomcat/README.txt | 32 -----
examples/camel-example-splunk/README.md | 63 +++++++++
examples/camel-example-splunk/README.txt | 45 -------
.../camel-example-spring-boot-metrics/README.md | 33 ++++-
examples/camel-example-spring-boot/README.md | 49 +++++++
examples/camel-example-spring-boot/README.txt | 41 ------
.../camel-example-spring-javaconfig/README.md | 41 ++++++
.../camel-example-spring-javaconfig/README.txt | 32 -----
examples/camel-example-spring-jms/README.md | 48 +++++++
examples/camel-example-spring-jms/README.txt | 41 ------
.../camel-example-spring-security/README.md | 41 ++++++
.../camel-example-spring-security/README.txt | 35 -----
examples/camel-example-spring-ws/README.md | 40 ++++++
examples/camel-example-spring-ws/README.txt | 35 -----
examples/camel-example-spring-xquery/README.md | 41 ++++++
examples/camel-example-spring-xquery/README.txt | 34 -----
examples/camel-example-spring/README.md | 40 ++++++
examples/camel-example-spring/README.txt | 32 -----
examples/camel-example-sql-blueprint/README.md | 72 ++++++++++
examples/camel-example-sql-blueprint/README.txt | 68 ----------
examples/camel-example-sql/README.md | 71 ++++++++++
examples/camel-example-sql/README.txt | 68 ----------
examples/camel-example-ssh-security/README.md | 99 ++++++++++++++
examples/camel-example-ssh-security/README.txt | 96 --------------
examples/camel-example-ssh/README.md | 39 ++++++
examples/camel-example-ssh/README.txt | 42 ------
examples/camel-example-swagger-cdi/README.md | 46 +++++++
examples/camel-example-swagger-cdi/README.txt | 38 ------
examples/camel-example-swagger-java/README.md | 44 +++++++
examples/camel-example-swagger-java/README.txt | 36 -----
examples/camel-example-tracer/README.md | 45 +++++++
examples/camel-example-tracer/README.txt | 36 -----
.../README.md | 63 +++++++++
.../README.txt | 58 --------
.../camel-example-twitter-websocket/README.md | 45 +++++++
.../camel-example-twitter-websocket/README.txt | 37 ------
59 files changed, 1477 insertions(+), 1244 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-bam/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-bam/README.md b/examples/camel-example-bam/README.md
index ccf5c5d..710992f 100644
--- a/examples/camel-example-bam/README.md
+++ b/examples/camel-example-bam/README.md
@@ -1,9 +1,9 @@
# Camel BAM Example
-### Introduction
+### Introduction
This example shows how to perform Business Activity Monitoring (BAM)
-with Camel.
+with Camel.
#### Camel component used in this example
@@ -16,9 +16,6 @@ with Camel.
You will need to compile this example first:
mvn compile
-
-For a background in BAM see
- [http://camel.apache.org/bam.html](http://camel.apache.org/bam.html)
### Run
@@ -28,18 +25,18 @@ To run the example with Maven, type
You can see the BAM activies defined in
`src/main/java/org/apache/camel/example/bam/MyActivites.java`
-
-To stop the example hit ctrl + c
+
+To stop the example hit `ctrl + c`
### Documentation
-This example is documented at
- [http://camel.apache.org/bam-example.html](http://camel.apache.org/bam-example.html)
+For a background in BAM see <http://camel.apache.org/bam.html>
+
+This example is documented at <http://camel.apache.org/bam-example.html>
-### Forum, Help, etc
+### 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)
+If you hit an 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!
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-etl/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-etl/README.md b/examples/camel-example-etl/README.md
index ba742f1..1cb91d2 100644
--- a/examples/camel-example-etl/README.md
+++ b/examples/camel-example-etl/README.md
@@ -3,7 +3,6 @@
### Introduction
This example shows how to use Camel as an ETL tool
- [http://camel.apache.org/etl.html](http://camel.apache.org/etl.html)
### Build
@@ -29,7 +28,7 @@ To stop the example hit `ctrl + c`
#### Build
You will need to compile and install this example first:
-
+
mvn install
#### Install
@@ -46,17 +45,17 @@ removed and you don't see the logs anymore written into the console, e.g. in cas
again using:
karaf clean
-
+
### Documentation
For a full description of this example please see
- [http://camel.apache.org/etl-example.html](http://camel.apache.org/etl-example.html)
+ <http://camel.apache.org/etl-example.html>
+<http://camel.apache.org/etl.html>
-### Forum, Help, etc
+### 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)
+If you hit an 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!
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-pojo-messaging/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-pojo-messaging/README.md b/examples/camel-example-pojo-messaging/README.md
new file mode 100644
index 0000000..677893a
--- /dev/null
+++ b/examples/camel-example-pojo-messaging/README.md
@@ -0,0 +1,33 @@
+# POJO Messaging Example
+
+### Introduction
+
+This example shows that you don't need to learn Camel's super cool DSLs
+if you don't want to. Camel has a set of annotations that allow you to
+produce, consume or route messages to endpoints.
+
+### Build
+
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+
+To run the example type
+
+ mvn camel:run
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+
+This example is documented at
+ <http://camel.apache.org/pojo-messaging-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>
+
+Please help us make Apache Camel better - we appreciate any feedback you may
+have. Enjoy!
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-pojo-messaging/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-pojo-messaging/README.txt b/examples/camel-example-pojo-messaging/README.txt
deleted file mode 100644
index ec1b929..0000000
--- a/examples/camel-example-pojo-messaging/README.txt
+++ /dev/null
@@ -1,23 +0,0 @@
-POJO Messaging Example
-======================
-
-This example shows that you don't need to learn Camel's super cool DSLs
-if you don't want to. Camel has a set of annotations that allow you to
-produce, consume or route messages to endpoints.
-
-The example should run if you type
- mvn compile camel:run
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/pojo-messaging-example.html
-
-If you hit an 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/149648b2/examples/camel-example-reportincident-wssecurity/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-reportincident-wssecurity/README.md b/examples/camel-example-reportincident-wssecurity/README.md
new file mode 100644
index 0000000..6c3a434
--- /dev/null
+++ b/examples/camel-example-reportincident-wssecurity/README.md
@@ -0,0 +1,131 @@
+# Report Incident Example
+
+### Introduction
+
+An example based on real life use case for reporting incidents using webservice
+that are transformed and send as emails to a backing system. WS-security has been
+implemented. So, the user must generates a SOAP envelope containing a SOAP header
+with wsse xml tag. A simple property map has been created containing user and password.
+We use Apache CXF WSS4JInterceptor to get the user/password and timestamp and authenticate
+the user using the WSS4J callback
+
+### Build
+
+You will need to compile this example first:
+
+ mvn install
+
+Remarks:
+- During the compilation phase, a unit test will be performed, this unit test simulates the
+ communication between a client calling the web services exposed by our camel/cxf routes. During the call,
+ the user "charles" is used to authenticate the web service call and the SOAP message created can be
+ retrieved from log file `target/camel-example-reportincident-wssecurity.log`
+- A mock SMTP server is used during unit test
+- 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.x
+
+#### Step 1: launch the server
+
+ karaf / karaf.bat
+
+ For Karaf: edit the file jre.properties 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, \
+
+ They are required by the following bundle : org.apache.servicemix.bundles/org.apache.servicemix.bundles.saaj-impl/1.3.2_1
+
+#### Step 2: Add features required
+
+ features:addUrl mvn:org.apache.camel.karaf/apache-camel/${version}/xml/features
+ features:install http
+ features:install camel
+ features:install camel-cxf
+ features:install camel-mail
+ features:install camel-velocity
+
+ remark: As the camel route sends email to a SMTP server, you must configure a user/password in your favorite
+ SMTP Server (James by example). User = someone and password = secret
+
+#### Step 3: Deploy our example
+
+ osgi:install -s mvn:org.apache.camel/camel-example-reportincident-wssecurity
+
+#### Step 4: Verify that your service is available using in the browser the following url
+
+ http://localhost:9081/camel-example-reportincident/webservices/incident?wsdl
+
+<http://localhost:9081/camel-example-reportincident/webservices/incident?wsdl>
+
+#### Step 5: Start SOAPUI (2.x)
+ Create a new project called `camel-example-reportincident-wssecurity`
+ Point to the following url : <http://localhost:9081/camel-example-reportincident/webservices/incident?wsdl>
+ Open the request 1 (under camel-example-reportincident-wssecurity --> ReportIncidentBinding --> ReportIncident) and copy/paste the SOAP
+ message generated by the unit test
+
+ ex :
+
+ 2010-07-14 09:57:54,403 [main ] INFO LoggingOutInterceptor - Outbound Message
+ ---------------------------
+ ID: 1
+ Address: http://localhost:9081/camel-example-reportincident/webservices/incident
+ Encoding: UTF-8
+ Content-Type: text/xml
+ Headers: {SOAPAction=["http://reportincident.example.camel.apache.org/ReportIncident"], Accept=[*/*]}
+ Payload: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Header><wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1"><wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Timestamp-2"><wsu:Created>2010-07-14T07:57:54.387Z</wsu:Created><wsu:Expires>2010-07-14T08:02:54.387Z</wsu:Expires></wsu:Timestamp><wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-1"><wsse:Username>charles</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">0U5uXRYukYG5PF82gsmncH+yWEE=</wsse:Password><wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-so
ap-message-security-1.0#Base64Binary">/Ka8O+F8cyufohiJFp8wjA==</wsse:Nonce><wsu:Created>2010-07-14T07:57:54.387Z</wsu:Created></wsse:UsernameToken></wsse:Security></soap:Header><soap:Body><ns2:inputReportIncident xmlns:ns2="http://reportincident.example.camel.apache.org"><incidentId>123</incidentId><incidentDate>2008-08-18</incidentDate><givenName>Claus</givenName><familyName>Ibsen</familyName><summary>Bla</summary><details>Bla bla</details><email>davsclaus@apache.org</email><phone>0045 2962 7576</phone></ns2:inputReportIncident></soap:Body></soap:Envelope>
+ --------------------------------------
+ 2010-07-14 09:57:54,403 [main ] DEBUG HTTPConduit - Sending POST Message with Headers to http://localhost:9080/camel-example-reportincident/webservices/incident Conduit :{http://reportincident.example.camel.apache.org}ReportIncidentEndpointPort.http-conduit
+
+ --> and the message formatted that you copy in SOAPUI
+
+ <?xml version="1.0" encoding="UTF-8"?>
+ <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+ <soap:Header>
+ <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
+ <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Timestamp-2">
+ <wsu:Created>2010-07-14T09:40:29.637Z</wsu:Created>
+ <wsu:Expires>2010-07-14T09:45:29.637Z</wsu:Expires>
+ </wsu:Timestamp>
+ <wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-1">
+ <wsse:Username>charles</wsse:Username>
+ <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">TVzWGxNvhlixNVWol8poD9DHxl8=</wsse:Password>
+ <wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">WsMNSm/C4dzdPS3OhUi94Q==</wsse:Nonce>
+ <wsu:Created>2010-07-14T09:40:29.637Z</wsu:Created>
+ </wsse:UsernameToken>
+ </wsse:Security>
+ </soap:Header>
+ <soap:Body>
+ <ns2:inputReportIncident xmlns:ns2="http://reportincident.example.camel.apache.org">
+ <incidentId>111</incidentId>
+ <incidentDate>2010-07-14</incidentDate>
+ <givenName>Charles</givenName>
+ <familyName>Moulliard</familyName>
+ <summary>Bla</summary>
+ <details>Bla bla</details>
+ <email>cmoulliard@apache.org</email>
+ <phone>0011 22 33 44</phone>
+ </ns2:inputReportIncident>
+ </soap:Body>
+ </soap:Envelope>
+
+
+ You can use another user: james, claus and retry.
+
+#### Step 6: Check email
+ Check through a POP request that a message has been published in the mailbox of someone (email address : incident@mycompany.com)
+
+### Documentation
+
+This example is documented at
+ <http://camel.apache.org/tutorial-osgi-camel-part1.html>
+
+### Forum, Help, etc
+
+If you hit an 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!
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-reportincident-wssecurity/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-reportincident-wssecurity/README.txt b/examples/camel-example-reportincident-wssecurity/README.txt
deleted file mode 100644
index 53e1fb6..0000000
--- a/examples/camel-example-reportincident-wssecurity/README.txt
+++ /dev/null
@@ -1,119 +0,0 @@
-Report Incident Example
-=======================
-
-An example based on real life use case for reporting incidents using webservice
-that are transformed and send as emails to a backing system. WS-security has been
-implemented. So, the user must generates a SOAP envelope containing a SOAP header
-with wsse xml tag. A simple property map has been created containing user and password.
-We use Apache CXF WSS4JInterceptor to get the user/password and timestamp and authenticate
-the user using the WSS4J callback
-
-You will need to compile this example first:
- mvn install
-
-Remarks:
-- During the compilation phase, a unit test will be performed, this unit test simulates the
- communication between a client calling the web services exposed by our camel/cxf routes. During the call,
- the user "charles" is used to authenticate the web service call and the SOAP message created can be
- retrieved from log file target/camel-example-reportincident-wssecurity.log
-- A mock SMTP server is used during unit test
-- 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.x
-
- 1) launch the server
- karaf.bat
-
- For Karaf: edit the file jre.properties 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, \
-
- They are required by the following bundle : org.apache.servicemix.bundles/org.apache.servicemix.bundles.saaj-impl/1.3.2_1
-
- 2) Add features required
- features:addUrl mvn:org.apache.camel.karaf/apache-camel/${version}/xml/features
- features:install http
- features:install camel
- features:install camel-cxf
- features:install camel-mail
- features:install camel-velocity
-
- remark: As the camel route sends email to a SMTP server, you must configure a user/password in your favorite
- SMTP Server (James by example). User = someone and password = secret
-
- 3) Deploy our example
- osgi:install -s mvn:org.apache.camel/camel-example-reportincident-wssecurity
-
- 4) Verify that your service is available using in the browser the following url
- http://localhost:9081/camel-example-reportincident/webservices/incident?wsdl
-
- 5) Start SOAPUI (2.x)
- Create a new project called camel-example-reportincident-wssecurity
- Point to the following url : http://localhost:9081/camel-example-reportincident/webservices/incident?wsdl
- Open the request 1 (under camel-example-reportincident-wssecurity --> ReportIncidentBinding --> ReportIncident) and copy/paste the SOAP
- message generated by the unit test
-
- ex :
-
- 2010-07-14 09:57:54,403 [main ] INFO LoggingOutInterceptor - Outbound Message
- ---------------------------
- ID: 1
- Address: http://localhost:9081/camel-example-reportincident/webservices/incident
- Encoding: UTF-8
- Content-Type: text/xml
- Headers: {SOAPAction=["http://reportincident.example.camel.apache.org/ReportIncident"], Accept=[*/*]}
- Payload: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Header><wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1"><wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Timestamp-2"><wsu:Created>2010-07-14T07:57:54.387Z</wsu:Created><wsu:Expires>2010-07-14T08:02:54.387Z</wsu:Expires></wsu:Timestamp><wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-1"><wsse:Username>charles</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">0U5uXRYukYG5PF82gsmncH+yWEE=</wsse:Password><wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-so
ap-message-security-1.0#Base64Binary">/Ka8O+F8cyufohiJFp8wjA==</wsse:Nonce><wsu:Created>2010-07-14T07:57:54.387Z</wsu:Created></wsse:UsernameToken></wsse:Security></soap:Header><soap:Body><ns2:inputReportIncident xmlns:ns2="http://reportincident.example.camel.apache.org"><incidentId>123</incidentId><incidentDate>2008-08-18</incidentDate><givenName>Claus</givenName><familyName>Ibsen</familyName><summary>Bla</summary><details>Bla bla</details><email>davsclaus@apache.org</email><phone>0045 2962 7576</phone></ns2:inputReportIncident></soap:Body></soap:Envelope>
- --------------------------------------
- 2010-07-14 09:57:54,403 [main ] DEBUG HTTPConduit - Sending POST Message with Headers to http://localhost:9080/camel-example-reportincident/webservices/incident Conduit :{http://reportincident.example.camel.apache.org}ReportIncidentEndpointPort.http-conduit
-
- --> and the message formatted that you copy in SOAPUI
-
- <?xml version="1.0" encoding="UTF-8"?>
- <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
- <soap:Header>
- <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1">
- <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Timestamp-2">
- <wsu:Created>2010-07-14T09:40:29.637Z</wsu:Created>
- <wsu:Expires>2010-07-14T09:45:29.637Z</wsu:Expires>
- </wsu:Timestamp>
- <wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-1">
- <wsse:Username>charles</wsse:Username>
- <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">TVzWGxNvhlixNVWol8poD9DHxl8=</wsse:Password>
- <wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">WsMNSm/C4dzdPS3OhUi94Q==</wsse:Nonce>
- <wsu:Created>2010-07-14T09:40:29.637Z</wsu:Created>
- </wsse:UsernameToken>
- </wsse:Security>
- </soap:Header>
- <soap:Body>
- <ns2:inputReportIncident xmlns:ns2="http://reportincident.example.camel.apache.org">
- <incidentId>111</incidentId>
- <incidentDate>2010-07-14</incidentDate>
- <givenName>Charles</givenName>
- <familyName>Moulliard</familyName>
- <summary>Bla</summary>
- <details>Bla bla</details>
- <email>cmoulliard@apache.org</email>
- <phone>0011 22 33 44</phone>
- </ns2:inputReportIncident>
- </soap:Body>
- </soap:Envelope>
-
-
- You can use another user: james, claus and retry.
-
- 6) Check email
- Check through a POP request that a message has been published in the mailbox of someone (email address : incident@mycompany.com)
-
-This example is documented at
- http://camel.apache.org/tutorial-osgi-camel-part1.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/149648b2/examples/camel-example-reportincident/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-reportincident/README.md b/examples/camel-example-reportincident/README.md
new file mode 100644
index 0000000..6270769
--- /dev/null
+++ b/examples/camel-example-reportincident/README.md
@@ -0,0 +1,43 @@
+# Report Incident Example
+
+### Introduction
+
+An example based on real life use case for reporting incidents using webservice
+that are transformed and send as emails to a backing system
+
+### Build
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+
+To run the example type
+
+ mvn jetty:run
+
+The webservice will be listed in this overview:
+
+ http://localhost:9080/webservices/
+
+<http://localhost:9080/webservices/>
+
+The webservice WSDL is exposed at:
+
+ http://localhost:9080/webservices/incident?wsdl
+
+<http://localhost:9080/webservices/incident?wsdl>
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+
+This example is documented at
+ <http://camel.apache.org/tutorial-example-reportincident.html>
+
+### Forum, Help, etc
+
+If you hit an 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!
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-reportincident/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-reportincident/README.txt b/examples/camel-example-reportincident/README.txt
deleted file mode 100644
index aac9b49..0000000
--- a/examples/camel-example-reportincident/README.txt
+++ /dev/null
@@ -1,31 +0,0 @@
-Report Incident Example
-=======================
-
-An example based on real life use case for reporting incidents using webservice
-that are transformed and send as emails to a backing system
-
-You will need to compile this example first:
- mvn compile
-
-To run the example type
- mvn jetty:run
-
-The webservice will be listed in this overview:
- http://localhost:9080/webservices/
-
-The webservice WSDL is exposed at:
- http://localhost:9080/webservices/incident?wsdl
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/tutorial-example-reportincident.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/149648b2/examples/camel-example-restlet-jdbc/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-restlet-jdbc/README.md b/examples/camel-example-restlet-jdbc/README.md
new file mode 100644
index 0000000..57320f0
--- /dev/null
+++ b/examples/camel-example-restlet-jdbc/README.md
@@ -0,0 +1,58 @@
+# Camel Restlet and JDBC Example
+
+### Introduction
+An example which shows how to expose CRUD operations with REST interface and JDBC implementation
+
+
+### Build
+
+You will need to compile this example first:
+
+ mvn install
+
+### Run
+
+To run the example type
+Run the application using XML-DSL:
+
+ mvn jetty:run
+
+### Run Java-DS
+To run with Java-DSL use:
+
+ mvn jetty:run -Dimpl=java-dsl
+
+### Run XML-REST-DSL
+To run with XML-REST-DSL use:
+
+ mvn jetty:run -Dimpl=xml-rest-dsl
+
+### Check
+To create an person, make a http POST request with firstName and lastName parameters:
+
+ curl -d "firstName=test&lastName=person" http://localhost:8080/rs/persons/
+
+To update an existing person, make a http PUT request with firstName and lastName parameters:
+
+ curl -X PUT -d "firstName=updated&lastName=person" http://localhost:8080/rs/persons/2
+
+To retrieve an existing person, make a http GET request with the personId as part of the url:
+
+ curl -X GET http://localhost:8080/rs/persons/1
+
+To delete an existing person, make a http DELETE request with the personId as part of the url:
+
+ curl -X DELETE http://localhost:8080/rs/persons/1
+
+To retrieve all the existing persons, make a http GET request to persons url:
+
+ curl -X GET http://localhost:8080/rs/persons
+
+### Forum, Help, etc
+
+If you hit an 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!
+
+
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-restlet-jdbc/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-restlet-jdbc/README.txt b/examples/camel-example-restlet-jdbc/README.txt
deleted file mode 100644
index d0725fd..0000000
--- a/examples/camel-example-restlet-jdbc/README.txt
+++ /dev/null
@@ -1,38 +0,0 @@
-Camel Restlet and JDBC Example
-==============================
-
-An example which shows how to expose CRUD operations with REST interface and JDBC implementation
-
-Compile: mvn clean install
-
-Run the application using XML-DSL: mvn jetty:run
-
-To run with Java-DSL use: mvn jetty:run -Dimpl=java-dsl
-
-To run with XML-REST-DSL use: mvn jetty:run -Dimpl=xml-rest-dsl
-
-To create an person, make a http POST request with firstName and lastName parameters:
-curl -d "firstName=test&lastName=person" http://localhost:8080/rs/persons/
-
-To update an existing person, make a http PUT request with firstName and lastName parameters:
-curl -X PUT -d "firstName=updated&lastName=person" http://localhost:8080/rs/persons/2
-
-To retrieve an existing person, make a http GET request with the personId as part of the url:
-curl -X GET http://localhost:8080/rs/persons/1
-
-To delete an existing person, make a http DELETE request with the personId as part of the url:
-curl -X DELETE http://localhost:8080/rs/persons/1
-
-To retrieve all the existing persons, make a http GET request to persons url:
-curl -X GET http://localhost:8080/rs/persons
-
-If you hit an 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/149648b2/examples/camel-example-route-throttling/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-route-throttling/README.md b/examples/camel-example-route-throttling/README.md
new file mode 100644
index 0000000..9739fc6
--- /dev/null
+++ b/examples/camel-example-route-throttling/README.md
@@ -0,0 +1,48 @@
+# Camel Route Throttling
+
+### Introduction
+
+This example shows how to use the new feature in Camel 2.1 which is RoutePolicy.
+A route policy allows you to associate a route with a policy. Camel provides a
+throttling policy which allows Camel to dynamic throttle the route consumer
+depending on the number of concurrent messages current in flight.
+
+The Server is required to be running when you start the client.
+You can see on the server it should log in the console how it adjust the
+throttling dynamically.
+
+The goal of this example is to illustrate that Camel throttles the JMS queue
+to be on same pace with the rest of the Camel routing. When running the example
+you should observe that the JMS route and the SEDA route completes nearly in sync.
+
+### Build
+
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+
+The example should run if you type:
+
+ mvn exec:java -PCamelServer
+
+
+ mvn exec:java -PCamelClient
+
+
+ mvn exec:java -PCamelFileClient
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+
+This example is documented at
+ <http://camel.apache.org/route-throttling-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>
+
+Please help us make Apache Camel better - we appreciate any feedback you may
+have. Enjoy!
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-route-throttling/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-route-throttling/README.txt b/examples/camel-example-route-throttling/README.txt
deleted file mode 100644
index fea04fe..0000000
--- a/examples/camel-example-route-throttling/README.txt
+++ /dev/null
@@ -1,42 +0,0 @@
-Camel Route Throttling
-======================
-
-This example shows how to use the new feature in Camel 2.1 which is RoutePolicy.
-A route policy allows you to associate a route with a policy. Camel provides a
-throttling policy which allows Camel to dynamic throttle the route consumer
-depending on the number of concurrent messages current in flight.
-
-The Server is required to be running when you start the client.
-You can see on the server it should log in the console how it adjust the
-throttling dynamically.
-
-The goal of this example is to illustrate that Camel throttles the JMS queue
-to be on same pace with the rest of the Camel routing. When running the example
-you should observe that the JMS route and the SEDA route completes nearly in sync.
-
-For the latest & greatest documentation on how to use this example please see:
- http://camel.apache.org/route-throttling-example.html
-
-You will need to compile this example first:
- mvn compile
-
-The example should run if you type:
- mvn exec:java -PCamelServer
-
- mvn exec:java -PCamelClient
-
- mvn exec:java -PCamelFileClient
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/route-throttling-example.html
-
-If you hit an 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/149648b2/examples/camel-example-servlet-rest-blueprint/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-servlet-rest-blueprint/README.md b/examples/camel-example-servlet-rest-blueprint/README.md
new file mode 100644
index 0000000..3b4f79e
--- /dev/null
+++ b/examples/camel-example-servlet-rest-blueprint/README.md
@@ -0,0 +1,66 @@
+# Camel Servlet REST and OSGi Blueprint example
+=============================================
+
+### Introduction
+This example shows how to use Servlet REST to define REST endpoints in Camel routes using the Rest DSL
+
+
+### Build
+You will need to compile this example first:
+
+ mvn install
+
+
+### run
+To install Apache Camel in Karaf you type in the shell (we use version ${project.version}):
+
+ features:chooseurl camel ${project.version}
+ features:install camel
+
+First you need to install the following features in Karaf/ServiceMix with:
+
+ features:install camel-servlet
+ features:install camel-jackson
+ features:install war
+
+Then you can install the Camel example:
+
+ osgi:install -s mvn:org.apache.camel/camel-example-servlet-rest-blueprint/${project.version}
+
+And you can see the application running by tailing the logs
+
+ log:tail
+
+And you can use `ctrl + c` to stop tailing the log.
+
+There is a user REST service that supports the following operations
+
+ - GET /user/{id} - to view a user with the given id </li>
+ - GET /user/final - to view all users</li>
+ - PUT /user - to update/create an user</li>
+
+The view operations are HTTP GET, and update is using HTTP PUT.
+
+From a web browser you can access the first two services using the following links
+
+ http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user/123 - to view the user with id 123
+ http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user/findAll - to list all users
+
+From the command shell you can use curl to access the service as shown below:
+
+ curl -X GET -H "Accept: application/json" http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user/123
+ curl -X GET -H "Accept: application/json" http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user/findAll
+ curl -X PUT -d "{ \"id\": 666, \"name\": \"The devil\"}" -H "Accept: application/json" http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user
+
+
+### Configuration
+This example is implemented in XML DSL in the `src/main/resources/OSGI-INF/bluepring/camel.xml` file.
+
+
+### Forum, Help, etc
+
+If you hit an 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!
+
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-servlet-rest-blueprint/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-servlet-rest-blueprint/README.txt b/examples/camel-example-servlet-rest-blueprint/README.txt
deleted file mode 100644
index 0f46216..0000000
--- a/examples/camel-example-servlet-rest-blueprint/README.txt
+++ /dev/null
@@ -1,63 +0,0 @@
-Camel Servlet REST and OSGi Blueprint example
-=============================================
-
-This example shows how to use Servlet REST to define REST endpoints in Camel routes using the Rest DSL
-
-This example is implemented in XML DSL in the `src/main/resources/OSGI-INF/bluepring/camel.xml` file.
-
-Apache Karaf / ServiceMix
--------------------------
-You will need to compile this example first:
- mvn compile
-
-To install Apache Camel in Karaf you type in the shell (we use version ${project.version}):
-
- features:chooseurl camel ${project.version}
- features:install camel
-
-First you need to install the following features in Karaf/ServiceMix with:
-
- features:install camel-servlet
- features:install camel-jackson
- features:install war
-
-Then you can install the Camel example:
-
- osgi:install -s mvn:org.apache.camel/camel-example-servlet-rest-blueprint/${project.version}
-
-And you can see the application running by tailing the logs
-
- log:tail
-
-And you can use ctrl + c to stop tailing the log.
-
-
-There is a user REST service that supports the following operations
-
- - GET /user/{id} - to view a user with the given id </li>
- - GET /user/final - to view all users</li>
- - PUT /user - to update/create an user</li>
-
-The view operations are HTTP GET, and update is using HTTP PUT.
-
-From a web browser you can access the first two services using the following links
-
- http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user/123 - to view the user with id 123
- http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user/findAll - to list all users
-
-
-From the command shell you can use curl to access the service as shown below:
-
- curl -X GET -H "Accept: application/json" http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user/123
- curl -X GET -H "Accept: application/json" http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user/findAll
- curl -X PUT -d "{ \"id\": 666, \"name\": \"The devil\"}" -H "Accept: application/json" http://localhost:8181/camel-example-servlet-rest-blueprint/rest/user
-
-
-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/149648b2/examples/camel-example-servlet-rest-tomcat/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-servlet-rest-tomcat/README.md b/examples/camel-example-servlet-rest-tomcat/README.md
new file mode 100644
index 0000000..1a75909
--- /dev/null
+++ b/examples/camel-example-servlet-rest-tomcat/README.md
@@ -0,0 +1 @@
+This example has been replaced with [camel-example-swagger-java](../camel-example-swagger-java)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-servlet-rest-tomcat/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-servlet-rest-tomcat/README.txt b/examples/camel-example-servlet-rest-tomcat/README.txt
deleted file mode 100644
index 0ea73bc..0000000
--- a/examples/camel-example-servlet-rest-tomcat/README.txt
+++ /dev/null
@@ -1 +0,0 @@
-This example has been replaced with camel-example-swagger-java
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-servlet-tomcat-no-spring/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-servlet-tomcat-no-spring/README.md b/examples/camel-example-servlet-tomcat-no-spring/README.md
new file mode 100644
index 0000000..d1403ae
--- /dev/null
+++ b/examples/camel-example-servlet-tomcat-no-spring/README.md
@@ -0,0 +1,39 @@
+# Camel Servlet and Apache Tomcat without Spring example
+
+### Introduction
+An example which shows how to use the Camel Servlet with Apache Tomcat,
+without using the Spring Framework.
+
+### Build
+You will need to package this example first:
+ mvn package
+
+### Run
+To run the example deploy it in Apache Tomcat by copying the `.war` to the
+deploy folder of Apache Tomcat.
+
+And then hit this url from a webbrowser which has further
+instructions
+
+ http://localhost:8080/camel-example-servlet-tomcat-no-spring
+<http://localhost:8080/camel-example-servlet-tomcat-no-spring>
+
+The servlet is located at
+ http://localhost:8080/camel-example-servlet-tomcat-no-spring/camel
+<http://localhost:8080/camel-example-servlet-tomcat-no-spring/camel>
+
+### Documentation
+
+This example is documented at
+ <http://camel.apache.org/servlet-tomcat-example-no-spring.html>
+
+### Forum, Help, etc
+
+If you hit an 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!
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-servlet-tomcat-no-spring/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-servlet-tomcat-no-spring/README.txt b/examples/camel-example-servlet-tomcat-no-spring/README.txt
deleted file mode 100644
index 243ab94..0000000
--- a/examples/camel-example-servlet-tomcat-no-spring/README.txt
+++ /dev/null
@@ -1,30 +0,0 @@
-Camel Servlet and Apache Tomcat without Spring example
-======================================================
-
-An example which shows how to use the Camel Servlet with Apache Tomcat,
-without using the Spring Framework.
-
-You will need to package this example first:
- mvn package
-
-To run the example deploy it in Apache Tomcat by copying the .war to the
-deploy folder of Apache Tomcat.
-
-And then hit this url from a webbrowser which has further
-instructions
- http://localhost:8080/camel-example-servlet-tomcat-no-spring
-
-The servlet is located at
- http://localhost:8080/camel-example-servlet-tomcat-no-spring/camel
-
-This example is documented at
- http://camel.apache.org/servlet-tomcat-example-no-spring.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!
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-servlet-tomcat/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-servlet-tomcat/README.md b/examples/camel-example-servlet-tomcat/README.md
new file mode 100644
index 0000000..a3ba525
--- /dev/null
+++ b/examples/camel-example-servlet-tomcat/README.md
@@ -0,0 +1,39 @@
+# Camel Servlet and Apache Tomcat example
+
+
+### Introduction
+An example which shows how to use the Camel Servlet with Apache Tomcat.
+
+### Build
+You will need to package this example first:
+
+ mvn package
+
+### Run
+
+To run the example deploy it in Apache Tomcat by copying the `.war` to the
+deploy folder of Apache Tomcat.
+
+And then hit this url from a webbrowser which has further
+instructions
+
+ http://localhost:8080/camel-example-servlet-tomcat
+<http://localhost:8080/camel-example-servlet-tomcat>
+
+The servlet is located at
+
+ http://localhost:8080/camel-example-servlet-tomcat/camel/hello
+<http://localhost:8080/camel-example-servlet-tomcat/camel/hello>
+
+### Documentation
+
+This example is documented at
+ <http://camel.apache.org/servlet-tomcat-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>
+
+Please help us make Apache Camel better - we appreciate any feedback you may
+have. Enjoy!
+
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-servlet-tomcat/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-servlet-tomcat/README.txt b/examples/camel-example-servlet-tomcat/README.txt
deleted file mode 100644
index 9673bad..0000000
--- a/examples/camel-example-servlet-tomcat/README.txt
+++ /dev/null
@@ -1,29 +0,0 @@
-Camel Servlet and Apache Tomcat example
-=======================================
-
-An example which shows how to use the Camel Servlet with Apache Tomcat.
-
-You will need to package this example first:
- mvn package
-
-To run the example deploy it in Apache Tomcat by copying the .war to the
-deploy folder of Apache Tomcat.
-
-And then hit this url from a webbrowser which has further
-instructions
- http://localhost:8080/camel-example-servlet-tomcat
-
-The servlet is located at
- http://localhost:8080/camel-example-servlet-tomcat/camel/hello
-
-This example is documented at
- http://camel.apache.org/servlet-tomcat-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!
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-simplejirabot/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-simplejirabot/README.md b/examples/camel-example-simplejirabot/README.md
new file mode 100644
index 0000000..b66a1c2
--- /dev/null
+++ b/examples/camel-example-simplejirabot/README.md
@@ -0,0 +1,47 @@
+# Camel-RSS to Camel-IRC Example
+
+### Introduction
+This example shows how to work with the Camel-RSS and Camel-irc components.
+
+The example creates a route that pulls from the Jira RSS feed for Camel,
+extracts the title then sends that to the irc endpoint which posts it in an IRC channel.
+
+There are 2 examples, one using XML configuration and the other using the Camel Java DSL.
+
+### Build
+
+You will need to compile this example first:
+ mvn compile
+
+### Run
+
+To run the Java DSL example type
+
+ cd javadsl
+ mvn camel:run
+
+To run the XML Configuration example type
+
+ cd xmlconf
+ mvn camel:run
+
+You can see the routing rules by looking at the java code in the
+`src/main/java` directory and the Spring XML configuration lives in
+`src/main/resources/META-INF/spring` in each module
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+
+This example is documented at <http://camel.apache.org/simple-jira-bot.html>
+
+### Forum, Help, etc
+
+If you hit an 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/149648b2/examples/camel-example-simplejirabot/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-simplejirabot/README.txt b/examples/camel-example-simplejirabot/README.txt
deleted file mode 100644
index 0315acb..0000000
--- a/examples/camel-example-simplejirabot/README.txt
+++ /dev/null
@@ -1,38 +0,0 @@
-Camel-RSS to Camel-IRC Example
-==============================
-
-This example shows how to work with the Camel-RSS and Camel-irc components.
-
-The example creates a route that pulls from the Jira RSS feed for Camel,
-extracts the title then sends that to the irc endpoint which posts it in an IRC channel.
-
-There are 2 examples, one using XML configuration and the other using the Camel Java DSL.
-
-You will need to compile this example first:
- mvn compile
-
-To run the Java DSL example type
- cd javadsl
- mvn camel:run
-
-To run the XML Configuration example type
- cd xmlconf
- mvn camel:run
-
-You can see the routing rules by looking at the java code in the
-src/main/java directory and the Spring XML configuration lives in
-src/main/resources/META-INF/spring in each module
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/simple-jira-bot.html
-
-If you hit any problems please talk to us 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/149648b2/examples/camel-example-spark-rest-tomcat/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spark-rest-tomcat/README.md b/examples/camel-example-spark-rest-tomcat/README.md
new file mode 100644
index 0000000..afcf91c
--- /dev/null
+++ b/examples/camel-example-spark-rest-tomcat/README.md
@@ -0,0 +1,42 @@
+# Camel Spark REST and Apache Tomcat example
+
+### Introduction
+This example shows how to use Spark REST to define REST endpoints in Camel routes using the Rest DSL
+Spark requires Java 8, so you will need to use Java 8.
+
+
+### Build
+You will need to package this example first:
+
+ mvn package
+
+### Run
+
+To run the example deploy it in Apache Tomcat by copying the `.war` to the
+deploy folder of Apache Tomcat.
+
+And then hit this url from a web browser which has further
+instructions
+
+ http://localhost:8080/camel-example-spark-rest-tomcat
+<http://localhost:8080/camel-example-spark-rest-tomcat>
+
+You can also try the example from Maven using
+
+ mvn jetty:run
+
+... and use the following url
+
+ http://localhost:8080/
+<http://localhost:8080/>
+
+### Forum, Help, etc
+
+If you hit an 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/149648b2/examples/camel-example-spark-rest-tomcat/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-spark-rest-tomcat/README.txt b/examples/camel-example-spark-rest-tomcat/README.txt
deleted file mode 100644
index 9cf1cbe..0000000
--- a/examples/camel-example-spark-rest-tomcat/README.txt
+++ /dev/null
@@ -1,32 +0,0 @@
-Camel Spark REST and Apache Tomcat example
-=======================================
-
-This example shows how to use Spark REST to define REST endpoints in Camel routes using the Rest DSL
-
-You will need to package this example first:
- mvn package
-
-Spark requires Java 8, so you will need to use Java 8.
-
-To run the example deploy it in Apache Tomcat by copying the .war to the
-deploy folder of Apache Tomcat.
-
-And then hit this url from a web browser which has further
-instructions
- http://localhost:8080/camel-example-spark-rest-tomcat
-
-You can also try the example from Maven using
- mvn jetty:run
-
-... and use the following url
-
- http://localhost:8080/
-
-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/149648b2/examples/camel-example-splunk/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-splunk/README.md b/examples/camel-example-splunk/README.md
new file mode 100644
index 0000000..4b81981
--- /dev/null
+++ b/examples/camel-example-splunk/README.md
@@ -0,0 +1,63 @@
+# Camel Splunk example
+
+### Introduction
+An example which shows how to integrate Camel with Splunk.
+
+This example requires that an Splunk Server is up and running.
+(For this example, sample data provide by Splunk was used. Steps
+for loading this data into splunk are documented here:
+ <http://docs.splunk.com/Documentation/Splunk/latest/SearchTutorial/GetthetutorialdataintoSplunk>)
+
+
+This project consists of the following examples:
+ -Random search query on Splunk
+ -Saved search query on Splunk
+ -Publish an event to Splunk
+
+
+### Build
+
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+
+To run the random search client you type:
+
+ mvn compile exec:java -Psearch-client
+
+... and response data will be printed on the console.
+
+To run the saved search client you type:
+
+ mvn compile exec:java -Psaved-search-client
+
+... and response data will be printed on the console.
+
+To run the saved search client you type:
+
+ mvn compile exec:java -Ppublish-event-client
+
+... and logs will be printed on the console.
+
+
+### Configuration
+
+You can configure the details of the Splunk server in the file:
+ `src/main/resources/application.properties`
+
+You can enable verbose logging by adjusting 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>
+
+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/149648b2/examples/camel-example-splunk/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-splunk/README.txt b/examples/camel-example-splunk/README.txt
deleted file mode 100644
index 5b61530..0000000
--- a/examples/camel-example-splunk/README.txt
+++ /dev/null
@@ -1,45 +0,0 @@
-Camel Splunk example
-=================
-
-An example which shows how to integrate Camel with Splunk.
-
-This example requires that an Splunk Server is up and running.
-(For this example, sample data provide by Splunk was used. Steps
-for loading this data into splunk are documented here:
- http://docs.splunk.com/Documentation/Splunk/latest/SearchTutorial/GetthetutorialdataintoSplunk)
-
-You can configure the details of the Splunk server in the file:
- src/main/resources/application.properties
-
-You will need to compile this example first:
- mvn compile
-
-This project consists of the following examples:
- -Random search query on Splunk
- -Saved search query on Splunk
- -Publish an event to Splunk
-
-
-To run the random search client you type:
- mvn compile exec:java -Psearch-client
-... and response data will be printed on the console.
-
-To run the saved search client you type:
- mvn compile exec:java -Psaved-search-client
-... and response data will be printed on the console.
-
-To run the saved search client you type:
- mvn compile exec:java -Ppublish-event-client
-... and logs will be printed on the console.
-
-You can enable verbose logging by adjusting 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/149648b2/examples/camel-example-spring-boot-metrics/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-boot-metrics/README.md b/examples/camel-example-spring-boot-metrics/README.md
index 2e941f3..9d73f89 100644
--- a/examples/camel-example-spring-boot-metrics/README.md
+++ b/examples/camel-example-spring-boot-metrics/README.md
@@ -1,7 +1,26 @@
-# camel-spring-boot-metrics-example
+# Camel Spring Boot Metrics Example
+
+### Introduction
This example sends Camel route metrics to Graphite from a Spring Boot app.
+Please read **Configuration** first
+
+### Build
+You will need to compile this example first:
+
+ mvn install
+
+### Run
+To run the example type
+
+ java -jar target/camel-example-spring-boot-metrics.jar
+
+
+
+You will see logging from the "Fast" and "Slow" routes, and metrics will be sent to Graphite (or nc) every 5 seconds.
+
+### Configuration
Spring Boot auto-configures the `com.codahale.metrics.MetricRegistry`. See code comments in `Application.java` for further details.
If you already have a Graphite server, make sure that UDP is enabled (set `ENABLE_UDP_LISTENER = True` in carbon.conf).
@@ -14,9 +33,13 @@ as shown here: http://metrics.dropwizard.io/3.1.0/manual/graphite/
If you can't be bothered to set up a Graphite server right now, you can simulate it by running `nc -ul 2003` on Linux.
If you don't have `nc`, use `yum search netcat` to find a suitable package to install (e.g. nmap-ncat.x86_64).
-When you're ready to try it:
+### Forum, Help, etc
- mvn clean install
- java -jar target/camel-example-spring-boot-metrics.jar
+If you hit an problems please let us know on the Camel Forums <http://camel.apache.org/discussion-forums.html>
-You will see logging from the "Fast" and "Slow" routes, and metrics will be sent to Graphite (or nc) every 5 seconds.
+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/149648b2/examples/camel-example-spring-boot/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-boot/README.md b/examples/camel-example-spring-boot/README.md
new file mode 100644
index 0000000..aba2838
--- /dev/null
+++ b/examples/camel-example-spring-boot/README.md
@@ -0,0 +1,49 @@
+# Spring Boot Example
+
+
+### Introduction
+This example shows how to work with the simple Camel application based on the Spring Boot.
+
+The example generates messages using timer trigger, writes them to the standard output and the mock
+endpoint (for testing purposes).
+
+This example exposes Jolokia API and Spring Boot actuators endpoints (like metrics) via the webmvc endpoint. We consider
+this as the best practice - Spring Boot applications with these API exposed can be easily monitored and managed by the
+3rd parties tools.
+
+We recommend to package your application as a fat WAR. Fat WARs can be executed just as regular fat jars, but you can also
+deploy them to the servlet containers like Tomcat. Fat WAR approach gives you the deployment flexibility, so we highly
+recommend it.
+
+### Build
+You will need to compile this example first:
+
+ mvn install
+
+### Run
+To run the example type
+
+ mvn spring-boot:run
+
+You can also execute the fat WAR directly:
+
+ java -jar target/camel-example-spring-boot.war
+
+You will see the message printed to the console every second.
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+
+This example is documented at <http://camel.apache.org/spring-boot-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>
+
+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/149648b2/examples/camel-example-spring-boot/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-boot/README.txt b/examples/camel-example-spring-boot/README.txt
deleted file mode 100644
index 599e241..0000000
--- a/examples/camel-example-spring-boot/README.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-Spring Example
-==============
-
-This example shows how to work with the simple Camel application based on the Spring Boot.
-
-The example generates messages using timer trigger, writes them to the standard output and the mock
-endpoint (for testing purposes).
-
-This example exposes Jolokia API and Spring Boot actuators endpoints (like metrics) via the webmvc endpoint. We consider
-this as the best practice - Spring Boot applications with these API exposed can be easily monitored and managed by the
-3rd parties tools.
-
-We recommend to package your application as a fat WAR. Fat WARs can be executed just as regular fat jars, but you can also
-deploy them to the servlet containers like Tomcat. Fat WAR approach gives you the deployment flexibility, so we highly
-recommend it.
-
-You will need to compile this example first:
- mvn install
-
-To run the example type
- mvn spring-boot:run
-
-You can also execute the fat WAR directly:
-
- java -jar target/camel-example-spring-boot.war
-
-You will see the message printed to the console every second.
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/spring-boot-example.html
-
-If you hit any problems please talk to us 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/149648b2/examples/camel-example-spring-javaconfig/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-javaconfig/README.md b/examples/camel-example-spring-javaconfig/README.md
new file mode 100644
index 0000000..c06d832
--- /dev/null
+++ b/examples/camel-example-spring-javaconfig/README.md
@@ -0,0 +1,41 @@
+# Spring Java Config Example
+
+### Introduction
+This example shows how to work with files and JMS, using Spring Java Config
+to boot up Camel and configure the routes.
+
+The example consumes messages from a queue and writes them to the file
+system.
+
+### Build
+You will need to compile this example first:
+
+ mvn compile
+
+
+### Run
+To run the example type
+
+ mvn camel:run
+
+To stop the example hit `ctrl + c`
+
+
+### Configuration
+You can see the routing rules by looking at the java code in the
+`src/main/java directory` and the Spring XML configuration lives in
+`src/main/resources/META-INF/spring`
+
+### Documentation
+This example is documented at <http://camel.apache.org/spring-java-config-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>
+
+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/149648b2/examples/camel-example-spring-javaconfig/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-javaconfig/README.txt b/examples/camel-example-spring-javaconfig/README.txt
deleted file mode 100644
index a2e5cd6..0000000
--- a/examples/camel-example-spring-javaconfig/README.txt
+++ /dev/null
@@ -1,32 +0,0 @@
-Spring Java Config Example
-==============
-
-This example shows how to work with files and JMS, using Spring Java Config
-to boot up Camel and configure the routes.
-
-The example consumes messages from a queue and writes them to the file
-system.
-
-You will need to compile this example first:
- mvn compile
-
-To run the example type
- mvn camel:run
-
-You can see the routing rules by looking at the java code in the
-src/main/java directory and the Spring XML configuration lives in
-src/main/resources/META-INF/spring
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/spring-java-config-example.html
-
-If you hit any problems please talk to us 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/149648b2/examples/camel-example-spring-jms/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-jms/README.md b/examples/camel-example-spring-jms/README.md
new file mode 100644
index 0000000..abc4b69
--- /dev/null
+++ b/examples/camel-example-spring-jms/README.md
@@ -0,0 +1,48 @@
+# Spring & JMS Example
+
+### Introduction
+This example shows how to work with the Camel-JMS Component.
+
+The example consumes messages from a queue and invoke the bean
+with the received message.
+
+The Server is required to be running when you try the clients.
+
+And for the Client we have a total of three flavors:
+- Normal use the ProducerTemplate ala Spring Template style
+- Using Spring Remoting for powerful "Client doesn't know at all its a remote call"
+- And using the Message Endpoint pattern using the neutral Camel API
+
+### Build
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+The example should run if you type:
+
+#### Step 1: Run Server
+ mvn exec:java -PCamelServer
+
+#### Step 2: Run Clients
+ mvn exec:java -PCamelClient
+ mvn exec:java -PCamelClientRemoting
+ mvn exec:java -PCamelClientEndpoint
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+
+This example is documented at <http://camel.apache.org/tutorial-jmsremoting.html>
+
+### Forum, Help, etc
+
+If you hit an 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/149648b2/examples/camel-example-spring-jms/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-jms/README.txt b/examples/camel-example-spring-jms/README.txt
deleted file mode 100644
index c939d7d..0000000
--- a/examples/camel-example-spring-jms/README.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-Spring & JMS Example
-====================
-
-This example shows how to work with the Camel-JMS Component.
-
-The example consumes messages from a queue and invoke the bean
-with the received message.
-
-The Server is required to be running when you try the clients.
-
-And for the Client we have a total of three flavors:
-- Normal use the ProducerTemplate ala Spring Template style
-- Using Spring Remoting for powerful "Client doesn't know at all its a remote call"
-- And using the Message Endpoint pattern using the neutral Camel API
-
-You will need to compile this example first:
- mvn compile
-
-The example should run if you type:
- mvn exec:java -PCamelServer
-
- mvn exec:java -PCamelClient
- mvn exec:java -PCamelClientRemoting
- mvn exec:java -PCamelClientEndpoint
-
-You can stack the maven goals so you can compile and execute it in one command:
- mvn compile exec:java -PCamelServer
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/tutorial-jmsremoting.html
-
-If you hit an 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/149648b2/examples/camel-example-spring-security/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-security/README.md b/examples/camel-example-spring-security/README.md
new file mode 100644
index 0000000..c49bfe8
--- /dev/null
+++ b/examples/camel-example-spring-security/README.md
@@ -0,0 +1,41 @@
+# Camel Spring Security Example
+
+### Introduction
+This example shows how to leverage the Spring Security to secure the camel endpoint.
+
+
+### Build
+You will need to compile this example first:
+
+ mvn clean install
+
+### Run
+To run the example, you need to start up the server by typing
+
+ mvn jetty:run
+
+To stop the server hit `ctrl + c`
+
+The example consumes messages from a servlet endpoint which is secured by Spring Security
+with http basic authentication, there are two service:
+ <http://localhost:8080/camel/user> is for the authenticated user whose role is ROLE_USER
+ <http://localhost:8080/camel/admin> is for the authenticated user whose role is ROLE_ADMIN
+
+
+Then you can use the script in the client directory to send the request and check the response,
+or use browser to access upper urls with the user/password
+(`jim/jimspassword` with the admin and user role or `bob/bobspassword` with user role).
+
+### Documentation
+This example is documented at <http://camel.apache.org/spring-security-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>
+
+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/149648b2/examples/camel-example-spring-security/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-security/README.txt b/examples/camel-example-spring-security/README.txt
deleted file mode 100644
index da58ae9..0000000
--- a/examples/camel-example-spring-security/README.txt
+++ /dev/null
@@ -1,35 +0,0 @@
-Camel Spring Security Example
-=============
-
-This example shows how to leverage the Spring Security to secure the camel endpoint.
-
-The example consumes messages from a servlet endpoint which is secured by Spring Security
-with http basic authentication, there are two service:
- "http://localhost:8080/camel/user" is for the authenticated user whose role is ROLE_USER
- "http://localhost:8080/camel/admin" is for the authenticated user whose role is ROLE_ADMIN
-
-You will need to compile this example first:
- mvn clean install
-
-To run the example, you need to start up the server by typing
- mvn jetty:run
-
-To stop the server hit ctrl + c
-
-Then you can use the script in the client directory to send the request and check the response,
-or use browser to access upper urls with the user/password
-("jim/jimspassword" with the admin and user role or "bob/bobspassword" with user role).
-
-This example is documented at
- http://camel.apache.org/spring-security-example.html
-
-If you hit any problems please talk to us 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/149648b2/examples/camel-example-spring-ws/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-ws/README.md b/examples/camel-example-spring-ws/README.md
new file mode 100644
index 0000000..78d2090
--- /dev/null
+++ b/examples/camel-example-spring-ws/README.md
@@ -0,0 +1,40 @@
+# Camel Spring Web Services Example
+
+### Introduction
+This example shows how to expose a SOAP-based web service using Camel and Spring Web Services.
+
+### Build
+You will need to compile this example first:
+ mvn clean install
+
+### Run
+To run the example, you need to start up the server by typing
+
+ mvn jetty:run
+
+To stop the server hit `ctrl + c`
+
+
+The web service endpoint address is:
+ <http://localhost:8080/increment>
+
+The WSDL is available at:
+ <http://localhost:8080/increment/increment.wsdl>
+
+
+You can test the web service using for example SOAP-UI. This excellent tool is freely available from http://www.soapui.org.
+There's a ready to use SOAP-UI project available in the `client` directory.
+
+### Documentation
+This example is documented at <http://camel.apache.org/spring-ws-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>
+
+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/149648b2/examples/camel-example-spring-ws/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-ws/README.txt b/examples/camel-example-spring-ws/README.txt
deleted file mode 100644
index 5d8e7c0..0000000
--- a/examples/camel-example-spring-ws/README.txt
+++ /dev/null
@@ -1,35 +0,0 @@
-Camel Spring Web Services Example
-=============
-
-This example shows how to expose a SOAP-based web service using Camel and Spring Web Services.
-
-The web service endpoint address is:
- http://localhost:8080/increment
-
-The WSDL is available at:
- http://localhost:8080/increment/increment.wsdl
-
-You will need to compile this example first:
- mvn clean install
-
-To run the example, you need to start up the server by typing
- mvn jetty:run
-
-To stop the server hit ctrl + c
-
-You can test the web service using for example SOAP-UI. This excellent tool is freely available from http://www.soapui.org.
-There's a ready to use SOAP-UI project available in the "client" directory.
-
-This example is documented at
- http://camel.apache.org/spring-ws-example.html
-
-If you hit any problems please talk to us 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/149648b2/examples/camel-example-spring-xquery/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-xquery/README.md b/examples/camel-example-spring-xquery/README.md
new file mode 100644
index 0000000..c381b47
--- /dev/null
+++ b/examples/camel-example-spring-xquery/README.md
@@ -0,0 +1,41 @@
+# Spring XQuery Example
+
+### Introduction
+This example shows how to
+
+ * work with files and JMS
+ * transform messages using XQuery
+ * use Spring XML to configure all routing rules and components
+
+The example consumes messages from a directory, transforms them, then sends
+them to a queue.
+
+### Build
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+To run the example using Maven, type
+
+ mvn camel:run
+
+You can see the routing rules by looking at the the Spring XML configuration
+at `src/main/resources/META-INF/spring`
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+This example is documented at <http://camel.apache.org/spring-xquery-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>
+
+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/149648b2/examples/camel-example-spring-xquery/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring-xquery/README.txt b/examples/camel-example-spring-xquery/README.txt
deleted file mode 100644
index 82c9750..0000000
--- a/examples/camel-example-spring-xquery/README.txt
+++ /dev/null
@@ -1,34 +0,0 @@
-Spring XQuery Example
-=====================
-
-This example shows how to
-
- * work with files and JMS
- * transform messages using XQuery
- * use Spring XML to configure all routing rules and components
-
-The example consumes messages from a directory, transforms them, then sends
-them to a queue.
-
-You will need to compile this example first:
- mvn compile
-
-To run the example using Maven, type
- mvn camel:run
-
-You can see the routing rules by looking at the the Spring XML configuration
-at src/main/resources/META-INF/spring
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/spring-xquery-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!
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-spring/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring/README.md b/examples/camel-example-spring/README.md
new file mode 100644
index 0000000..778ac6c
--- /dev/null
+++ b/examples/camel-example-spring/README.md
@@ -0,0 +1,40 @@
+# Spring Example
+
+### Introduction
+This example shows how to work with files and JMS, using Spring to boot up
+Camel and configure the routes.
+
+The example consumes messages from a queue and writes them to the file
+system.
+
+
+### Build
+You will need to compile this example first:
+
+ mvn compile
+
+### Run
+To run the example type
+
+ mvn camel:run
+
+You can see the routing rules by looking at the java code in the
+`src/main/java directory` and the Spring XML configuration lives in
+`src/main/resources/META-INF/spring`
+
+To stop the example hit `ctrl + c`
+
+### Documentation
+
+This example is documented at <http://camel.apache.org/spring-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>
+
+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/149648b2/examples/camel-example-spring/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-spring/README.txt b/examples/camel-example-spring/README.txt
deleted file mode 100644
index 771df46..0000000
--- a/examples/camel-example-spring/README.txt
+++ /dev/null
@@ -1,32 +0,0 @@
-Spring Example
-==============
-
-This example shows how to work with files and JMS, using Spring to boot up
-Camel and configure the routes.
-
-The example consumes messages from a queue and writes them to the file
-system.
-
-You will need to compile this example first:
- mvn compile
-
-To run the example type
- mvn camel:run
-
-You can see the routing rules by looking at the java code in the
-src/main/java directory and the Spring XML configuration lives in
-src/main/resources/META-INF/spring
-
-To stop the example hit ctrl + c
-
-This example is documented at
- http://camel.apache.org/spring-example.html
-
-If you hit any problems please talk to us 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/149648b2/examples/camel-example-sql-blueprint/README.md
----------------------------------------------------------------------
diff --git a/examples/camel-example-sql-blueprint/README.md b/examples/camel-example-sql-blueprint/README.md
new file mode 100644
index 0000000..1f9cf48
--- /dev/null
+++ b/examples/camel-example-sql-blueprint/README.md
@@ -0,0 +1,72 @@
+# Camel SQL Blueprint Example
+
+### Introduction
+This example shows how to exchange data using a shared database table.
+
+The example has two Camel routes. The first route insert new data into the table,
+triggered by a timer to run every 5th second.
+
+The second route pickup the newly inserted rows from the table,
+process the row(s), and mark the row(s) as processed when done;
+to avoid picking up the same rows again.
+
+### Build
+You will need to compile this example first:
+ mvn install
+
+
+### Run with maven
+To run the example type
+
+ mvn camel:run
+
+To stop the example hit `ctrl + c`
+
+This example uses Blueprint to setup and configure the database,
+as well the CamelContext. You can see this in the following file:
+In the src/main/resources/OSGI-INF/blueprint/camel-context.xml
+
+### Run with Karaf
+You will need to compile this example first:
+
+ mvn compile
+
+To install Apache Camel in Karaf you type in the shell (we use version ${project.version}):
+
+ features:chooseurl camel ${project.version}
+ features:install camel
+
+First you need to install the following features in Karaf/ServiceMix with:
+
+ features:install camel-blueprint
+ features:install camel-sql
+
+Then you need to install JDBC connection pool and the Derby Database:
+
+ osgi:install -s mvn:commons-pool/commons-pool/1.6
+ osgi:install -s mvn:org.apache.servicemix.bundles/org.apache.servicemix.bundles.commons-dbcp/1.4_3
+ osgi:install -s mvn:org.apache.derby/derby/10.10.1.1
+
+Then you can install the Camel example:
+
+ osgi:install -s mvn:org.apache.camel/camel-example-sql-blueprint/${project.version}
+
+And you can see the application running by tailing the logs
+
+ log:tail
+
+And you can use `ctrl + c` to stop tailing the log.
+
+### Documentation
+This example is documented at <http://camel.apache.org/sql-example-blueprint.html>
+
+### Forum, Help, etc
+
+If you hit an 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!
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/149648b2/examples/camel-example-sql-blueprint/README.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-sql-blueprint/README.txt b/examples/camel-example-sql-blueprint/README.txt
deleted file mode 100644
index ff72a9b..0000000
--- a/examples/camel-example-sql-blueprint/README.txt
+++ /dev/null
@@ -1,68 +0,0 @@
-Camel SQL Blueprint Example
-=================
-
-This example shows how to exchange data using a shared database table.
-
-The example has two Camel routes. The first route insert new data into the table,
-triggered by a timer to run every 5th second.
-
-The second route pickup the newly inserted rows from the table,
-process the row(s), and mark the row(s) as processed when done;
-to avoid picking up the same rows again.
-
-Standalone
-----------
-You will need to compile this example first:
- mvn compile
-
-To run the example type
- mvn camel:run
-
-To stop the example hit ctrl + c
-
-This example uses Blueprint to setup and configure the database,
-as well the CamelContext. You can see this in the following file:
-In the src/main/resources/OSGI-INF/blueprint/camel-context.xml
-
-Apache Karaf / ServiceMix
--------------------------
-You will need to compile this example first:
- mvn compile
-
-To install Apache Camel in Karaf you type in the shell (we use version ${project.version}):
-
- features:chooseurl camel ${project.version}
- features:install camel
-
-First you need to install the following features in Karaf/ServiceMix with:
-
- features:install camel-blueprint
- features:install camel-sql
-
-Then you need to install JDBC connection pool and the Derby Database:
-
- osgi:install -s mvn:commons-pool/commons-pool/1.6
- osgi:install -s mvn:org.apache.servicemix.bundles/org.apache.servicemix.bundles.commons-dbcp/1.4_3
- osgi:install -s mvn:org.apache.derby/derby/10.10.1.1
-
-Then you can install the Camel example:
-
- osgi:install -s mvn:org.apache.camel/camel-example-sql-blueprint/${project.version}
-
-And you can see the application running by tailing the logs
-
- log:tail
-
-And you can use ctrl + c to stop tailing the log.
-
-This example is documented at
- http://camel.apache.org/sql-example-blueprint.html
-
-If you hit any problems please talk to us 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!