From 6f3a3682ffd383594b71ef88a6ac85b2c9ceb7a8 Mon Sep 17 00:00:00 2001 From: Tadayoshi Sato Date: Tue, 24 Jul 2018 18:37:13 +0900 Subject: [PATCH] Add camel-ehcache blueprint example --- .../camel-example-ehcache-blueprint/README.md | 61 ++++++ .../camel-example-ehcache-blueprint/pom.xml | 86 ++++++++ .../camel/example/ehcache/CacheData.java | 58 +++++ .../camel/example/ehcache/CachingRoute.java | 60 ++++++ .../camel/example/ehcache/DataService.java | 44 ++++ .../src/main/resources/META-INF/LICENSE.txt | 203 ++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 + .../OSGI-INF/blueprint/camel-context.xml | 46 ++++ .../src/main/resources/ehcache.xml | 36 ++++ .../src/main/resources/log4j2.properties | 23 ++ examples/pom.xml | 1 + 11 files changed, 629 insertions(+) create mode 100644 examples/camel-example-ehcache-blueprint/README.md create mode 100644 examples/camel-example-ehcache-blueprint/pom.xml create mode 100644 examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/CacheData.java create mode 100644 examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/CachingRoute.java create mode 100644 examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/DataService.java create mode 100644 examples/camel-example-ehcache-blueprint/src/main/resources/META-INF/LICENSE.txt create mode 100644 examples/camel-example-ehcache-blueprint/src/main/resources/META-INF/NOTICE.txt create mode 100644 examples/camel-example-ehcache-blueprint/src/main/resources/OSGI-INF/blueprint/camel-context.xml create mode 100644 examples/camel-example-ehcache-blueprint/src/main/resources/ehcache.xml create mode 100644 examples/camel-example-ehcache-blueprint/src/main/resources/log4j2.properties diff --git a/examples/camel-example-ehcache-blueprint/README.md b/examples/camel-example-ehcache-blueprint/README.md new file mode 100644 index 0000000000000..979161004e291 --- /dev/null +++ b/examples/camel-example-ehcache-blueprint/README.md @@ -0,0 +1,61 @@ +# Camel Ehcache Blueprint example + +### Introduction +This example shows how to use `camel-ehcache` to cache messages in a Camel route. + +### Build +You will need to compile this example first: + + mvn install + + +### Run with Karaf +To install Apache Camel in Karaf you type in the shell (we use version ${project.version}): + + feature:repo-add camel ${project.version} + feature:install camel + +First you need to install the following features in Karaf with: + + feature:install camel-ehcache + feature:install camel-servlet + feature:install camel-jackson + + +Then you can install the example: + + install -s mvn:org.apache.camel.example/camel-example-ehcache-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 data REST service that supports the following operation(s): + +- GET /data/{id} - to get data with the given id from an external service + +From a web browser you can access the service using the following link(s): + + http://localhost:8181/camel-example-ehcache-blueprint/data/123 - to get the data with id 123 + +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-ehcache-blueprint/data/123 + +The first time you try to get the data it will take 3 seconds as the example (pretends to) access an external data service. +But then the data will be cached, so it will be quick afterward. + + +### Configuration +This example is implemented in XML DSL in the `src/main/resources/OSGI-INF/bluepring/camel-context.xml` file. + + +### Forum, Help, etc + +If you hit an problems please let us know on the Camel Forums + + +Please help us make Apache Camel better - we appreciate any feedback you may +have. Enjoy! diff --git a/examples/camel-example-ehcache-blueprint/pom.xml b/examples/camel-example-ehcache-blueprint/pom.xml new file mode 100644 index 0000000000000..996d0c28c5ea2 --- /dev/null +++ b/examples/camel-example-ehcache-blueprint/pom.xml @@ -0,0 +1,86 @@ + + + + + 4.0.0 + + + org.apache.camel.example + examples + 2.23.0-SNAPSHOT + + + camel-example-ehcache-blueprint + Camel :: Example :: Ehcache :: Blueprint + An example using Ehcache with OSGi Blueprint + jar + + + OSGi + Ehcache Blueprint + + + * + + + * + + + + + + + + org.apache.camel + camel-blueprint + + + org.apache.camel + camel-ehcache + + + org.apache.camel + camel-servlet + + + org.apache.camel + camel-jackson + + + + + org.apache.logging.log4j + log4j-api + runtime + + + org.apache.logging.log4j + log4j-core + runtime + + + org.apache.logging.log4j + log4j-slf4j-impl + runtime + + + + diff --git a/examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/CacheData.java b/examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/CacheData.java new file mode 100644 index 0000000000000..c06485a29bd31 --- /dev/null +++ b/examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/CacheData.java @@ -0,0 +1,58 @@ +/** + * 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.ehcache; + +import java.io.Serializable; +import java.util.Date; + +import com.fasterxml.jackson.annotation.JsonFormat; + +public class CacheData implements Serializable { + + private static final long serialVersionUID = 996437822624011472L; + + private Long id; + + private String value; + + @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") + private Date created; + + public Long getId() { + return id; + } + + public void setId(Long id) { + this.id = id; + } + + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + + public Date getCreated() { + return created; + } + + public void setCreated(Date created) { + this.created = created; + } +} diff --git a/examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/CachingRoute.java b/examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/CachingRoute.java new file mode 100644 index 0000000000000..9e8e4318c07b8 --- /dev/null +++ b/examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/CachingRoute.java @@ -0,0 +1,60 @@ +/** + * 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.ehcache; + +import org.apache.camel.builder.RouteBuilder; +import org.apache.camel.component.ehcache.EhcacheConstants; +import org.apache.camel.model.rest.RestBindingMode; + +public class CachingRoute extends RouteBuilder { + + private static final String EHCACHE_ENDPOINT = "ehcache://dataServiceCache" + + "?configurationUri=/ehcache.xml" + + "&keyType=java.lang.Long" + + "&valueType=java.io.Serializable"; + + @Override + public void configure() { + restConfiguration() + .component("servlet") + .bindingMode(RestBindingMode.json) + .contextPath("/camel-example-ehcache-blueprint") + .port(8181) + .dataFormatProperty("prettyPrint", "true"); + + rest("/data").consumes("application/json").produces("application/json") + .get("/{id}").to("direct:getData"); + + // @formatter:off + from("direct:getData").routeId("ehcache-example-get") + .log("ID = ${header.id}") + .setHeader(EhcacheConstants.ACTION, constant(EhcacheConstants.ACTION_GET)) + .setHeader(EhcacheConstants.KEY, header("id").convertTo(Long.class)) + .to(EHCACHE_ENDPOINT) + .choice() + .when(header(EhcacheConstants.ACTION_HAS_RESULT).isNotEqualTo("true")) + .log("No cache hit. Fetching data from external service") + .to("bean:dataService?method=getData(${header.id})") + .setHeader(EhcacheConstants.ACTION, constant(EhcacheConstants.ACTION_PUT)) + .setHeader(EhcacheConstants.KEY, header("id").convertTo(Long.class)) + .to(EHCACHE_ENDPOINT) + .otherwise() + .log("Cache hit. Returning") + .endChoice(); + // @formatter:on + } +} diff --git a/examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/DataService.java b/examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/DataService.java new file mode 100644 index 0000000000000..48c899aac965d --- /dev/null +++ b/examples/camel-example-ehcache-blueprint/src/main/java/org/apache/camel/example/ehcache/DataService.java @@ -0,0 +1,44 @@ +/** + * 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.ehcache; + +import java.util.Date; +import java.util.UUID; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class DataService { + + private static final Logger LOG = LoggerFactory.getLogger(DataService.class); + + public CacheData getData(Long id) { + LOG.info("Creating data with ID = {}", id); + + // simulating time-consuming calculation + try { + Thread.sleep(3000); + } catch (Exception e) { + } + + CacheData data = new CacheData(); + data.setId(id); + data.setValue(UUID.randomUUID().toString()); + data.setCreated(new Date()); + return data; + } +} diff --git a/examples/camel-example-ehcache-blueprint/src/main/resources/META-INF/LICENSE.txt b/examples/camel-example-ehcache-blueprint/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 0000000000000..6b0b1270ff0ca --- /dev/null +++ b/examples/camel-example-ehcache-blueprint/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. + diff --git a/examples/camel-example-ehcache-blueprint/src/main/resources/META-INF/NOTICE.txt b/examples/camel-example-ehcache-blueprint/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000000000..2e215bf2e6b1f --- /dev/null +++ b/examples/camel-example-ehcache-blueprint/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. diff --git a/examples/camel-example-ehcache-blueprint/src/main/resources/OSGI-INF/blueprint/camel-context.xml b/examples/camel-example-ehcache-blueprint/src/main/resources/OSGI-INF/blueprint/camel-context.xml new file mode 100644 index 0000000000000..4e2ad04c02ea2 --- /dev/null +++ b/examples/camel-example-ehcache-blueprint/src/main/resources/OSGI-INF/blueprint/camel-context.xml @@ -0,0 +1,46 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/examples/camel-example-ehcache-blueprint/src/main/resources/ehcache.xml b/examples/camel-example-ehcache-blueprint/src/main/resources/ehcache.xml new file mode 100644 index 0000000000000..b1f87dcc1de65 --- /dev/null +++ b/examples/camel-example-ehcache-blueprint/src/main/resources/ehcache.xml @@ -0,0 +1,36 @@ + + + + + + + + java.lang.Long + java.io.Serializable + + 100 + 10 + + + + diff --git a/examples/camel-example-ehcache-blueprint/src/main/resources/log4j2.properties b/examples/camel-example-ehcache-blueprint/src/main/resources/log4j2.properties new file mode 100644 index 0000000000000..9deb51c460b6d --- /dev/null +++ b/examples/camel-example-ehcache-blueprint/src/main/resources/log4j2.properties @@ -0,0 +1,23 @@ +## --------------------------------------------------------------------------- +## 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. +## --------------------------------------------------------------------------- + +appender.console.type = Console +appender.console.name = console +appender.console.layout.type = PatternLayout +appender.console.layout.pattern = %d [%-15.15t] %-5p %-30.30c{1} - %m%n +rootLogger.level = INFO +rootLogger.appenderRef.console.ref = console diff --git a/examples/pom.xml b/examples/pom.xml index c888bcb862092..033f27439a14a 100644 --- a/examples/pom.xml +++ b/examples/pom.xml @@ -60,6 +60,7 @@ camel-example-cxf-proxy camel-example-cxf-tomcat camel-example-console + camel-example-ehcache-blueprint camel-example-ftp camel-example-google-pubsub camel-example-guice-jms