Repository: camel Updated Branches: refs/heads/master 4cbc22b24 -> c5adfe634
CAMEL-7354: Rest DSL. Integrate with camel-servlet. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/c5adfe63 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/c5adfe63 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/c5adfe63 Branch: refs/heads/master Commit: c5adfe634404f314c61687f2953eb2ba2326b9b0 Parents: a5cecf8 Author: Claus Ibsen <davscl...@apache.org> Authored: Mon Jul 28 20:58:12 2014 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Tue Jul 29 08:08:58 2014 +0200 ---------------------------------------------------------------------- .../processor/binding/RestBindingProcessor.java | 39 ++-- .../README.txt | 32 +++ .../camel-example-servlet-rest-tomcat/pom.xml | 84 ++++++++ .../org/apache/camel/example/rest/User.java | 47 +++++ .../camel/example/rest/UserRouteBuilder.java | 49 +++++ .../apache/camel/example/rest/UserService.java | 64 ++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 + .../src/main/resources/camel-config.xml | 36 ++++ .../src/main/resources/log4j.properties | 28 +++ .../src/main/webapp/WEB-INF/web.xml | 49 +++++ .../src/main/webapp/index.html | 66 ++++++ .../camel-example-spark-rest-tomcat/README.txt | 10 +- .../src/main/webapp/index.html | 6 +- examples/pom.xml | 1 + parent/pom.xml | 5 + 16 files changed, 704 insertions(+), 26 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/camel-core/src/main/java/org/apache/camel/processor/binding/RestBindingProcessor.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/processor/binding/RestBindingProcessor.java b/camel-core/src/main/java/org/apache/camel/processor/binding/RestBindingProcessor.java index 0ae78d8..03fea60 100644 --- a/camel-core/src/main/java/org/apache/camel/processor/binding/RestBindingProcessor.java +++ b/camel-core/src/main/java/org/apache/camel/processor/binding/RestBindingProcessor.java @@ -105,12 +105,6 @@ public class RestBindingProcessor extends ServiceSupport implements AsyncProcess return true; } - // is the body empty - if (exchange.getIn().getBody() == null) { - callback.done(true); - return true; - } - boolean isXml = false; boolean isJson = false; @@ -137,20 +131,24 @@ public class RestBindingProcessor extends ServiceSupport implements AsyncProcess isJson = bindingMode.equals("auto") || bindingMode.contains("json"); } - // okay we have a binding mode, so need to check for empty body as that can cause the marshaller to fail - // as they assume a non-empty body String body = null; - if (isXml || isJson) { - // we have binding enabled, so we need to know if there body is empty or not\ - // so force reading the body as a String which we can work with - body = MessageHelper.extractBodyAsString(exchange.getIn()); - if (body != null) { - exchange.getIn().setBody(body); - - if (isXml && isJson) { - // we have still not determined between xml or json, so check the body if its xml based or not - isXml = body.startsWith("<"); - isJson = !isXml; + + if (exchange.getIn().getBody() != null) { + + // okay we have a binding mode, so need to check for empty body as that can cause the marshaller to fail + // as they assume a non-empty body + if (isXml || isJson) { + // we have binding enabled, so we need to know if there body is empty or not\ + // so force reading the body as a String which we can work with + body = MessageHelper.extractBodyAsString(exchange.getIn()); + if (body != null) { + exchange.getIn().setBody(body); + + if (isXml && isJson) { + // we have still not determined between xml or json, so check the body if its xml based or not + isXml = body.startsWith("<"); + isJson = !isXml; + } } } } @@ -178,6 +176,7 @@ public class RestBindingProcessor extends ServiceSupport implements AsyncProcess // we could not bind if (bindingMode.equals("auto")) { // okay for auto we do not mind if we could not bind + exchange.addOnCompletion(new RestBindingMarshalOnCompletion(exchange.getFromRouteId(), jsonMarshal, xmlMarshal, false)); callback.done(true); return true; } else { @@ -250,7 +249,7 @@ public class RestBindingProcessor extends ServiceSupport implements AsyncProcess } // is the body empty - if (exchange.hasOut() && exchange.getOut().getBody() == null || exchange.getIn().getBody() == null) { + if ((exchange.hasOut() && exchange.getOut().getBody() == null) || (!exchange.hasOut() && exchange.getIn().getBody() == null)) { return; } http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/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 new file mode 100644 index 0000000..6f77cd5 --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/README.txt @@ -0,0 +1,32 @@ +Camel Servlet REST and Apache Tomcat example +======================================= + +This example shows how to use Servlet 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 (use correct version number) + http://localhost:8080/camel-example-servlet-rest-tomcat-{version} + +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/c5adfe63/examples/camel-example-servlet-rest-tomcat/pom.xml ---------------------------------------------------------------------- diff --git a/examples/camel-example-servlet-rest-tomcat/pom.xml b/examples/camel-example-servlet-rest-tomcat/pom.xml new file mode 100755 index 0000000..3258e48 --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/pom.xml @@ -0,0 +1,84 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.camel</groupId> + <artifactId>examples</artifactId> + <version>2.14-SNAPSHOT</version> + </parent> + + <artifactId>camel-example-servlet-rest-tomcat</artifactId> + <name>Camel :: Example :: Servlet REST Tomcat</name> + <description>An example using Servlet REST with Apache Tomcat</description> + <packaging>war</packaging> + + <dependencies> + + <!-- camel --> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-core</artifactId> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-spring</artifactId> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-servlet</artifactId> + </dependency> + + <!-- use for json binding --> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-jackson</artifactId> + </dependency> + + <!-- we need spring web --> + <dependency> + <groupId>org.springframework</groupId> + <artifactId>spring-web</artifactId> + </dependency> + + <!-- logging --> + <dependency> + <groupId>log4j</groupId> + <artifactId>log4j</artifactId> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + </dependency> + + </dependencies> + + <build> + <plugins> + <plugin> + <groupId>org.eclipse.jetty</groupId> + <artifactId>jetty-maven-plugin</artifactId> + <version>${jetty9-version}</version> + </plugin> + </plugins> + </build> + +</project> http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/User.java ---------------------------------------------------------------------- diff --git a/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/User.java b/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/User.java new file mode 100644 index 0000000..25b1721 --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/User.java @@ -0,0 +1,47 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.example.rest; + +public class User { + + private int id; + private String name; + + public User() { + } + + public User(int id, String name) { + this.id = id; + this.name = name; + } + + public int getId() { + return id; + } + + public void setId(int id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/UserRouteBuilder.java ---------------------------------------------------------------------- diff --git a/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/UserRouteBuilder.java b/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/UserRouteBuilder.java new file mode 100644 index 0000000..46280cd --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/UserRouteBuilder.java @@ -0,0 +1,49 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.example.rest; + +import org.apache.camel.builder.RouteBuilder; +import org.apache.camel.model.rest.RestBindingMode; + +/** + * Define REST services using the Camel REST DSL + */ +public class UserRouteBuilder extends RouteBuilder { + + @Override + public void configure() throws Exception { + + // configure we want to use servlet as the component for the rest DSL + // and we enable json binding mode + restConfiguration().component("servlet").bindingMode(RestBindingMode.json) + // and output using pretty print + .dataFormatProperty("prettyPrint", "true"); + + // this user REST service is json only + rest("/user").consumes("application/json").produces("application/json") + + .get("/view/{id}").outType(User.class) + .to("bean:userService?method=getUser(${header.id})") + + .get("/list").outTypeList(User.class) + .to("bean:userService?method=listUsers") + + .put("/update").type(User.class).outType(User.class) + .to("bean:userService?method=updateUser"); + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/UserService.java ---------------------------------------------------------------------- diff --git a/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/UserService.java b/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/UserService.java new file mode 100644 index 0000000..e59ce5f --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/src/main/java/org/apache/camel/example/rest/UserService.java @@ -0,0 +1,64 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.example.rest; + +import java.util.Collection; +import java.util.Map; +import java.util.TreeMap; + +/** + * A {@link org.apache.camel.example.rest.User} service which we rest enable from the {@link org.apache.camel.example.rest.UserRouteBuilder}. + */ +public class UserService { + + // use a tree map so they become sorted + private final Map<String, User> users = new TreeMap<String, User>(); + + public UserService() { + users.put("123", new User(123, "John Doe")); + users.put("456", new User(456, "Donald Duck")); + } + + /** + * Gets a user by the given id + * + * @param id the id of the user + * @return the user, or <tt>null</tt> if no user exists + */ + public User getUser(String id) { + return users.get(id); + } + + /** + * List all users + * + * @return the list of all users + */ + public Collection<User> listUsers() { + return users.values(); + } + + /** + * Updates or creates the given user + * + * @param user the user + * @return the old user before it was updated, or <tt>null</tt> if creating a new user + */ + public User updateUser(User user) { + return users.put("" + user.getId(), user); + } +} http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/camel-example-servlet-rest-tomcat/src/main/resources/META-INF/LICENSE.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-servlet-rest-tomcat/src/main/resources/META-INF/LICENSE.txt b/examples/camel-example-servlet-rest-tomcat/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 0000000..6b0b127 --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/camel-example-servlet-rest-tomcat/src/main/resources/META-INF/NOTICE.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-servlet-rest-tomcat/src/main/resources/META-INF/NOTICE.txt b/examples/camel-example-servlet-rest-tomcat/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000..2e215bf --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/camel-example-servlet-rest-tomcat/src/main/resources/camel-config.xml ---------------------------------------------------------------------- diff --git a/examples/camel-example-servlet-rest-tomcat/src/main/resources/camel-config.xml b/examples/camel-example-servlet-rest-tomcat/src/main/resources/camel-config.xml new file mode 100755 index 0000000..2e4b838 --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/src/main/resources/camel-config.xml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<beans xmlns="http://www.springframework.org/schema/beans"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xmlns:camel="http://camel.apache.org/schema/spring"; + xsi:schemaLocation=" + http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd + http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd";> + + <!-- a rest service which uses binding to/from pojos --> + <bean id="userRoutes" class="org.apache.camel.example.rest.UserRouteBuilder"/> + + <!-- a bean for user services --> + <bean id="userService" class="org.apache.camel.example.rest.UserService"/> + + <camelContext xmlns="http://camel.apache.org/schema/spring";> + <routeBuilder ref="userRoutes"/> + </camelContext> + +</beans> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/camel-example-servlet-rest-tomcat/src/main/resources/log4j.properties ---------------------------------------------------------------------- diff --git a/examples/camel-example-servlet-rest-tomcat/src/main/resources/log4j.properties b/examples/camel-example-servlet-rest-tomcat/src/main/resources/log4j.properties new file mode 100755 index 0000000..b5c95ab --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/src/main/resources/log4j.properties @@ -0,0 +1,28 @@ +## ------------------------------------------------------------------------ +## Licensed to the Apache Software Foundation (ASF) under one or more +## contributor license agreements. See the NOTICE file distributed with +## this work for additional information regarding copyright ownership. +## The ASF licenses this file to You under the Apache License, Version 2.0 +## (the "License"); you may not use this file except in compliance with +## the License. You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## ------------------------------------------------------------------------ + +# default properties to initialise log4j +log4j.rootLogger=INFO, console + +# settings for specific packages +#log4j.logger.org.apache.camel.component.servlet=DEBUG +#log4j.logger.org.apache.camel=DEBUG + +# Console appender +log4j.appender.console=org.apache.log4j.ConsoleAppender +log4j.appender.console.layout=org.apache.log4j.PatternLayout +log4j.appender.console.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %m%n http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/camel-example-servlet-rest-tomcat/src/main/webapp/WEB-INF/web.xml ---------------------------------------------------------------------- diff --git a/examples/camel-example-servlet-rest-tomcat/src/main/webapp/WEB-INF/web.xml b/examples/camel-example-servlet-rest-tomcat/src/main/webapp/WEB-INF/web.xml new file mode 100755 index 0000000..4244072 --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/src/main/webapp/WEB-INF/web.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd";> + + <display-name>My Camel Rest Application</display-name> + + <!-- location of Camel Spring xml files --> + <context-param> + <param-name>contextConfigLocation</param-name> + <param-value>classpath:camel-config.xml</param-value> + </context-param> + + <!-- the listener that kick-starts Spring --> + <listener> + <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> + </listener> + + <!-- to setup Camel Servlet --> + <servlet> + <servlet-name>CamelServlet</servlet-name> + <display-name>Camel Http Transport Servlet</display-name> + <servlet-class>org.apache.camel.component.servlet.CamelHttpTransportServlet</servlet-class> + </servlet> + + <!-- define that url path for the Camel Servlet to use --> + <servlet-mapping> + <servlet-name>CamelServlet</servlet-name> + <url-pattern>/rest/*</url-pattern> + </servlet-mapping> + +</web-app> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/camel-example-servlet-rest-tomcat/src/main/webapp/index.html ---------------------------------------------------------------------- diff --git a/examples/camel-example-servlet-rest-tomcat/src/main/webapp/index.html b/examples/camel-example-servlet-rest-tomcat/src/main/webapp/index.html new file mode 100644 index 0000000..bfad504 --- /dev/null +++ b/examples/camel-example-servlet-rest-tomcat/src/main/webapp/index.html @@ -0,0 +1,66 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + +<body> +<h2>Servlet REST and Apache Tomcat example</h2> + +This example shows how to use Servlet REST to define REST endpoints in Camel routes using Java DSL + +<br/> +The routes are defined in Java code, in the <tt>org.apache.camel.example.rest.UserRouteBuilder</tt> class. + +<p/> +There is a <i>user</i> REST service that supports the following operations + <ul> + <li>view/<i>id</i> - to view a user with the given id </li> + <li>list - to view all users</li> + <li>update - to update/create an user</li> + </ul> + +The view and list 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 + +<ul> + <li><a href="rest/user/view/123">user/view/123</a> - to view the user with id 123</li> + <li><a href="rest/user/list">user/list</a> - to list all users</li> +</ul> + +From the command shell you can use curl to access the service as shown below: +<pre> + curl -X GET -H "Accept: application/json" http://localhost:8080/camel-example-servlet-rest-tomcat-{version}/rest/user/view/123 + curl -X GET -H "Accept: application/json" http://localhost:8080/camel-example-servlet-rest-tomcat-{version}/rest/user/list + curl -X PUT -d "{ \"id\": 666, \"name\": \"The devil\"}" -H "Accept: application/json" http://localhost:8080/camel-example-servlet-rest-tomcat-{version}/rest/user/update +</pre> + +This assume you installed the example by copying the .war as <tt>camel-example-servlet-rest-tomcat-VERSION.war</tt> +, where VERSION is the Camel version such as 2.14.0, into the <b>webapps</b> directory of Apache Tomcat. + +<p/> +If you hit any problems please let us know on the +<a href="http://camel.apache.org/discussion-forums.html";>Camel Forums</a> +<br/> +<br/> +Please help us make Apache Camel better - we appreciate any feedback you may +have. Enjoy! +<br/> +<br/> +The Camel riders! +</body> + +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/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 index b1f350b..578c7bf 100644 --- a/examples/camel-example-spark-rest-tomcat/README.txt +++ b/examples/camel-example-spark-rest-tomcat/README.txt @@ -11,13 +11,17 @@ 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. -You can also try the example from maven using - mvn jetty:run - And then hit this url from a web browser which has further instructions (use correct version number) http://localhost:8080/camel-example-spark-rest-tomcat-{version} +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 http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/camel-example-spark-rest-tomcat/src/main/webapp/index.html ---------------------------------------------------------------------- diff --git a/examples/camel-example-spark-rest-tomcat/src/main/webapp/index.html b/examples/camel-example-spark-rest-tomcat/src/main/webapp/index.html index c2559c4..ec96441 100644 --- a/examples/camel-example-spark-rest-tomcat/src/main/webapp/index.html +++ b/examples/camel-example-spark-rest-tomcat/src/main/webapp/index.html @@ -19,7 +19,7 @@ <body> <h2>Spark REST and Apache Tomcat example</h2> -This example shows how to use Spark REST to define REST endpoints in Camel routes using the CamelSparkRouteBuilder DSL +This example shows how to use Spark REST to define REST endpoints in Camel routes using the Java DSL <br/> The routes are defined in Java code, in the <tt>org.apache.camel.example.sparkrest.UserRouteBuilder</tt> class. @@ -37,8 +37,8 @@ The view and list 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 <ul> - <li><a href="/user/view/123">user/view/123</a> - to view the user with id 123</li> - <li><a href="/user/list">user/list</a> - to list all users</li> + <li><a href="user/view/123">user/view/123</a> - to view the user with id 123</li> + <li><a href="user/list">user/list</a> - to list all users</li> </ul> From the command shell you can use curl to access the service as shown below: http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/examples/pom.xml ---------------------------------------------------------------------- diff --git a/examples/pom.xml b/examples/pom.xml index 7e5a5fb..50010f2 100644 --- a/examples/pom.xml +++ b/examples/pom.xml @@ -63,6 +63,7 @@ <module>camel-example-reportincident-wssecurity</module> <module>camel-example-restlet-jdbc</module> <module>camel-example-route-throttling</module> + <module>camel-example-servlet-rest-tomcat</module> <module>camel-example-servlet-tomcat</module> <module>camel-example-servlet-tomcat-blueprintweb</module> <module>camel-example-servlet-tomcat-no-spring</module> http://git-wip-us.apache.org/repos/asf/camel/blob/c5adfe63/parent/pom.xml ---------------------------------------------------------------------- diff --git a/parent/pom.xml b/parent/pom.xml index a0675a3..8dd2e3a 100644 --- a/parent/pom.xml +++ b/parent/pom.xml @@ -1485,6 +1485,11 @@ </dependency> <dependency> <groupId>org.apache.camel</groupId> + <artifactId>camel-example-servlet-rest-tomcat</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> <artifactId>camel-example-servlet-tomcat</artifactId> <version>${project.version}</version> </dependency>
