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!
