CAMEL-10434: Camel catalog support different runtimes to provide their supported list of components etc.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/473d90a3 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/473d90a3 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/473d90a3 Branch: refs/heads/camel-2.18.x Commit: 473d90a348e7ff784cfdadcea70ca4f6d0f188a0 Parents: 40ae459 Author: Claus Ibsen <davscl...@apache.org> Authored: Mon Nov 7 15:35:55 2016 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Mon Nov 7 16:46:44 2016 +0100 ---------------------------------------------------------------------- platforms/catalog-provider-karaf/pom.xml | 1 - .../src/main/resources/META-INF/LICENSE.txt | 203 ++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 + platforms/catalog-provider-springboot/pom.xml | 99 ++++ .../springboot/SpringBootRuntimeProvider.java | 97 ++++ .../src/main/resources/META-INF/LICENSE.txt | 203 ++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 + .../SpringBootRuntimeProviderTest.java | 96 ++++ platforms/pom.xml | 1 + .../packaging/PrepareCatalogSpringBootMojo.java | 520 +++++++++++++++++++ 10 files changed, 1241 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/473d90a3/platforms/catalog-provider-karaf/pom.xml ---------------------------------------------------------------------- diff --git a/platforms/catalog-provider-karaf/pom.xml b/platforms/catalog-provider-karaf/pom.xml index bc2853a..5e56781 100644 --- a/platforms/catalog-provider-karaf/pom.xml +++ b/platforms/catalog-provider-karaf/pom.xml @@ -84,7 +84,6 @@ <version>${project.version}</version> <executions> <execution> - <!-- prepare the catalog before the user guide / readme --> <goals> <goal>prepare-catalog-karaf</goal> </goals> http://git-wip-us.apache.org/repos/asf/camel/blob/473d90a3/platforms/catalog-provider-karaf/src/main/resources/META-INF/LICENSE.txt ---------------------------------------------------------------------- diff --git a/platforms/catalog-provider-karaf/src/main/resources/META-INF/LICENSE.txt b/platforms/catalog-provider-karaf/src/main/resources/META-INF/LICENSE.txt new file mode 100755 index 0000000..6b0b127 --- /dev/null +++ b/platforms/catalog-provider-karaf/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/473d90a3/platforms/catalog-provider-karaf/src/main/resources/META-INF/NOTICE.txt ---------------------------------------------------------------------- diff --git a/platforms/catalog-provider-karaf/src/main/resources/META-INF/NOTICE.txt b/platforms/catalog-provider-karaf/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000..2e215bf --- /dev/null +++ b/platforms/catalog-provider-karaf/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/473d90a3/platforms/catalog-provider-springboot/pom.xml ---------------------------------------------------------------------- diff --git a/platforms/catalog-provider-springboot/pom.xml b/platforms/catalog-provider-springboot/pom.xml new file mode 100644 index 0000000..557510f --- /dev/null +++ b/platforms/catalog-provider-springboot/pom.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="UTF-8"?> +<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";> + <!-- + 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. + --> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.camel</groupId> + <artifactId>platforms</artifactId> + <version>2.19.0-SNAPSHOT</version> + </parent> + + <artifactId>camel-catalog-provider-springboot</artifactId> + <packaging>jar</packaging> + <name>Camel :: Platforms :: Catalog :: Provider Spring Boot</name> + <description>Camel Catalog Spring Boot</description> + + <properties> + <camel.osgi.export.pkg> + org.apache.camel.catalog.springboot + </camel.osgi.export.pkg> + </properties> + + <dependencies> + + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-catalog</artifactId> + </dependency> + + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + + <!-- logging --> + <dependency> + <groupId>org.apache.logging.log4j</groupId> + <artifactId>log4j-api</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.apache.logging.log4j</groupId> + <artifactId>log4j-core</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.apache.logging.log4j</groupId> + <artifactId>log4j-slf4j-impl</artifactId> + <scope>test</scope> + </dependency> + + </dependencies> + + <build> + <plugins> + + <plugin> + <groupId>org.apache.felix</groupId> + <artifactId>maven-bundle-plugin</artifactId> + <extensions>true</extensions> + </plugin> + + <!-- generate and include all components in the catalog --> + <plugin> + <groupId>org.apache.camel</groupId> + <artifactId>camel-package-maven-plugin</artifactId> + <version>${project.version}</version> + <executions> + <execution> + <goals> + <goal>prepare-catalog-springboot</goal> + </goals> + <phase>process-resources</phase> + </execution> + </executions> + </plugin> + + </plugins> + + </build> + +</project> http://git-wip-us.apache.org/repos/asf/camel/blob/473d90a3/platforms/catalog-provider-springboot/src/main/java/org/apache/camel/catalog/springboot/SpringBootRuntimeProvider.java ---------------------------------------------------------------------- diff --git a/platforms/catalog-provider-springboot/src/main/java/org/apache/camel/catalog/springboot/SpringBootRuntimeProvider.java b/platforms/catalog-provider-springboot/src/main/java/org/apache/camel/catalog/springboot/SpringBootRuntimeProvider.java new file mode 100644 index 0000000..8b61ede --- /dev/null +++ b/platforms/catalog-provider-springboot/src/main/java/org/apache/camel/catalog/springboot/SpringBootRuntimeProvider.java @@ -0,0 +1,97 @@ +/** + * 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.catalog.springboot; + +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.List; + +import org.apache.camel.catalog.CamelCatalog; +import org.apache.camel.catalog.CatalogHelper; +import org.apache.camel.catalog.RuntimeProvider; + +/** + * A Spring Boot based {@link RuntimeProvider} which only includes the supported Camel components, data formats, and languages + * which can be installed in Spring Boot using the starter dependencies. + */ +public class SpringBootRuntimeProvider implements RuntimeProvider { + + private static final String COMPONENTS_CATALOG = "org/apache/camel/catalog/springboot/components.properties"; + private static final String DATA_FORMATS_CATALOG = "org/apache/camel/catalog/springboot/dataformats.properties"; + private static final String LANGUAGE_CATALOG = "org/apache/camel/catalog/springboot/languages.properties"; + + private CamelCatalog camelCatalog; + + @Override + public CamelCatalog getCamelCatalog() { + return camelCatalog; + } + + @Override + public void setCamelCatalog(CamelCatalog camelCatalog) { + this.camelCatalog = camelCatalog; + } + + @Override + public String getProviderName() { + return "springboot"; + } + + @Override + public List<String> findComponentNames() { + List<String> names = new ArrayList<String>(); + InputStream is = camelCatalog.getVersionManager().getResourceAsStream(COMPONENTS_CATALOG); + if (is != null) { + try { + CatalogHelper.loadLines(is, names); + } catch (IOException e) { + // ignore + } + } + return names; + } + + @Override + public List<String> findDataFormatNames() { + List<String> names = new ArrayList<String>(); + InputStream is = camelCatalog.getVersionManager().getResourceAsStream(DATA_FORMATS_CATALOG); + if (is != null) { + try { + CatalogHelper.loadLines(is, names); + } catch (IOException e) { + // ignore + } + } + return names; + } + + @Override + public List<String> findLanguageNames() { + List<String> names = new ArrayList<String>(); + InputStream is = camelCatalog.getVersionManager().getResourceAsStream(LANGUAGE_CATALOG); + if (is != null) { + try { + CatalogHelper.loadLines(is, names); + } catch (IOException e) { + // ignore + } + } + return names; + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/473d90a3/platforms/catalog-provider-springboot/src/main/resources/META-INF/LICENSE.txt ---------------------------------------------------------------------- diff --git a/platforms/catalog-provider-springboot/src/main/resources/META-INF/LICENSE.txt b/platforms/catalog-provider-springboot/src/main/resources/META-INF/LICENSE.txt new file mode 100755 index 0000000..6b0b127 --- /dev/null +++ b/platforms/catalog-provider-springboot/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/473d90a3/platforms/catalog-provider-springboot/src/main/resources/META-INF/NOTICE.txt ---------------------------------------------------------------------- diff --git a/platforms/catalog-provider-springboot/src/main/resources/META-INF/NOTICE.txt b/platforms/catalog-provider-springboot/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000..2e215bf --- /dev/null +++ b/platforms/catalog-provider-springboot/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/473d90a3/platforms/catalog-provider-springboot/src/test/java/org/apache/camel/catalog/springboot/SpringBootRuntimeProviderTest.java ---------------------------------------------------------------------- diff --git a/platforms/catalog-provider-springboot/src/test/java/org/apache/camel/catalog/springboot/SpringBootRuntimeProviderTest.java b/platforms/catalog-provider-springboot/src/test/java/org/apache/camel/catalog/springboot/SpringBootRuntimeProviderTest.java new file mode 100644 index 0000000..879129d --- /dev/null +++ b/platforms/catalog-provider-springboot/src/test/java/org/apache/camel/catalog/springboot/SpringBootRuntimeProviderTest.java @@ -0,0 +1,96 @@ +/** + * 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.catalog.springboot; + +import java.util.List; + +import org.apache.camel.catalog.CamelCatalog; +import org.apache.camel.catalog.DefaultCamelCatalog; +import org.junit.BeforeClass; +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; + +public class SpringBootRuntimeProviderTest { + + static CamelCatalog catalog; + + @BeforeClass + public static void createCamelCatalog() { + catalog = new DefaultCamelCatalog(); + catalog.setRuntimeProvider(new SpringBootRuntimeProvider()); + } + + @Test + public void testGetVersion() throws Exception { + String version = catalog.getCatalogVersion(); + assertNotNull(version); + + String loaded = catalog.getLoadedVersion(); + assertNotNull(loaded); + assertEquals(version, loaded); + } + + @Test + public void testProviderName() throws Exception { + assertEquals("springboot", catalog.getRuntimeProvider().getProviderName()); + } + + @Test + public void testFindComponentNames() throws Exception { + List<String> names = catalog.findComponentNames(); + + assertNotNull(names); + assertFalse(names.isEmpty()); + + assertTrue(names.contains("file")); + assertTrue(names.contains("ftp")); + assertTrue(names.contains("jms")); + // camel-ejb does not work in spring-boot + assertFalse(names.contains("ejb")); + // camel-pac-logging does not work in spring-boot + assertFalse(names.contains("paxlogging")); + } + + @Test + public void testFindDataFormatNames() throws Exception { + List<String> names = catalog.findDataFormatNames(); + + assertNotNull(names); + assertFalse(names.isEmpty()); + + assertTrue(names.contains("bindy-csv")); + assertTrue(names.contains("zip")); + assertTrue(names.contains("zipfile")); + } + + @Test + public void testFindLanguageNames() throws Exception { + List<String> names = catalog.findLanguageNames(); + + assertNotNull(names); + assertFalse(names.isEmpty()); + + assertTrue(names.contains("simple")); + assertTrue(names.contains("spel")); + assertTrue(names.contains("xpath")); + } + +} http://git-wip-us.apache.org/repos/asf/camel/blob/473d90a3/platforms/pom.xml ---------------------------------------------------------------------- diff --git a/platforms/pom.xml b/platforms/pom.xml index d0811ac..e75d45f 100644 --- a/platforms/pom.xml +++ b/platforms/pom.xml @@ -40,6 +40,7 @@ <module>catalog-lucene</module> <module>catalog-maven</module> <module>catalog-provider-karaf</module> + <module>catalog-provider-springboot</module> </modules> </project> http://git-wip-us.apache.org/repos/asf/camel/blob/473d90a3/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogSpringBootMojo.java ---------------------------------------------------------------------- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogSpringBootMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogSpringBootMojo.java new file mode 100644 index 0000000..dffc9de --- /dev/null +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogSpringBootMojo.java @@ -0,0 +1,520 @@ +/** + * 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 + * <p> + * http://www.apache.org/licenses/LICENSE-2.0 + * <p> + * 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.maven.packaging; + +import java.io.File; +import java.io.FileFilter; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.nio.channels.FileChannel; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Set; +import java.util.TreeSet; + +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.project.MavenProject; +import org.apache.maven.project.MavenProjectHelper; + +import static org.apache.camel.maven.packaging.PackageHelper.loadText; + +/** + * Prepares the Spring Boot provider camel catalog to include component it supports + * + * @goal prepare-catalog-springboot + */ +public class PrepareCatalogSpringBootMojo extends AbstractMojo { + + public static final int BUFFER_SIZE = 128 * 1024; + + /** + * The maven project. + * + * @parameter property="project" + * @required + * @readonly + */ + protected MavenProject project; + + /** + * The output directory for components catalog + * + * @parameter default-value="${project.build.directory}/classes/org/apache/camel/catalog/springboot/components" + */ + protected File componentsOutDir; + + /** + * The output directory for dataformats catalog + * + * @parameter default-value="${project.build.directory}/classes/org/apache/camel/catalog/springboot/dataformats" + */ + protected File dataFormatsOutDir; + + /** + * The output directory for languages catalog + * + * @parameter default-value="${project.build.directory}/classes/org/apache/camel/catalog/springboot/languages" + */ + protected File languagesOutDir; + + /** + * The directory where all spring-boot starters are + * + * @parameter default-value="${project.build.directory}/../../../components-starter" + */ + protected File componentsStarterDir; + + /** + * The components directory where all the Apache Camel components are + * + * @parameter default-value="${project.build.directory}/../../../components" + */ + protected File componentsDir; + + /** + * The camel-core directory where camel-core components are + * + * @parameter default-value="${project.build.directory}/../../../camel-core" + */ + protected File coreDir; + + /** + * Maven ProjectHelper. + * + * @component + * @readonly + */ + private MavenProjectHelper projectHelper; + + /** + * Execute goal. + * + * @throws MojoExecutionException execution of the main class or one of the + * threads it generated failed. + * @throws MojoFailureException something bad happened... + */ + public void execute() throws MojoExecutionException, MojoFailureException { + Set<String> starters = findSpringBootStarters(); + executeComponents(starters); + executeDataFormats(starters); + executeLanguages(starters); + } + + protected void executeComponents(Set<String> starters) throws MojoExecutionException, MojoFailureException { + getLog().info("Copying all Camel component json descriptors"); + + // lets use sorted set/maps + Set<File> jsonFiles = new TreeSet<File>(); + Set<File> componentFiles = new TreeSet<File>(); + + // find all json files in components and camel-core + if (componentsDir != null && componentsDir.isDirectory()) { + File[] components = componentsDir.listFiles(); + if (components != null) { + for (File dir : components) { + // skip camel-spring-dm + if (dir.isDirectory() && "camel-spring-dm".equals(dir.getName())) { + continue; + } + + + if (dir.isDirectory() && !"target".equals(dir.getName())) { + File target = new File(dir, "target/classes"); + + // the directory must be in the list of known features + if (!starters.contains(dir.getName())) { + continue; + } + + // special for camel-salesforce which is in a sub dir + if ("camel-salesforce".equals(dir.getName())) { + target = new File(dir, "camel-salesforce-component/target/classes"); + } else if ("camel-linkedin".equals(dir.getName())) { + target = new File(dir, "camel-linkedin-component/target/classes"); + } + + + findComponentFilesRecursive(target, jsonFiles, componentFiles, new CamelComponentsFileFilter()); + } + } + } + } + if (coreDir != null && coreDir.isDirectory()) { + File target = new File(coreDir, "target/classes"); + findComponentFilesRecursive(target, jsonFiles, componentFiles, new CamelComponentsFileFilter()); + } + + getLog().info("Found " + componentFiles.size() + " component.properties files"); + getLog().info("Found " + jsonFiles.size() + " component json files"); + + // make sure to create out dir + componentsOutDir.mkdirs(); + + Set<String> alternativeSchemes = new HashSet<>(); + + for (File file : jsonFiles) { + File to = new File(componentsOutDir, file.getName()); + try { + copyFile(file, to); + } catch (IOException e) { + throw new MojoFailureException("Cannot copy file from " + file + " -> " + to, e); + } + } + + File all = new File(componentsOutDir, "../components.properties"); + try { + FileOutputStream fos = new FileOutputStream(all, false); + + String[] names = componentsOutDir.list(); + List<String> components = new ArrayList<String>(); + // sort the names + for (String name : names) { + if (name.endsWith(".json")) { + // strip out .json from the name + String componentName = name.substring(0, name.length() - 5); + components.add(componentName); + } + } + + Collections.sort(components); + for (String name : components) { + fos.write(name.getBytes()); + fos.write("\n".getBytes()); + } + + fos.close(); + + } catch (IOException e) { + throw new MojoFailureException("Error writing to file " + all); + } + } + + protected void executeDataFormats(Set<String> starters) throws MojoExecutionException, MojoFailureException { + getLog().info("Copying all Camel dataformat json descriptors"); + + // lets use sorted set/maps + Set<File> jsonFiles = new TreeSet<File>(); + Set<File> dataFormatFiles = new TreeSet<File>(); + + // find all data formats from the components directory + if (componentsDir != null && componentsDir.isDirectory()) { + File[] dataFormats = componentsDir.listFiles(); + if (dataFormats != null) { + for (File dir : dataFormats) { + if (dir.isDirectory() && !"target".equals(dir.getName())) { + // skip camel-spring-dm + if (dir.isDirectory() && "camel-spring-dm".equals(dir.getName())) { + continue; + } + // the directory must be in the list of known features + if (!starters.contains(dir.getName())) { + continue; + } + File target = new File(dir, "target/classes"); + findDataFormatFilesRecursive(target, jsonFiles, dataFormatFiles, new CamelDataFormatsFileFilter()); + } + } + } + } + if (coreDir != null && coreDir.isDirectory()) { + File target = new File(coreDir, "target/classes"); + findDataFormatFilesRecursive(target, jsonFiles, dataFormatFiles, new CamelDataFormatsFileFilter()); + } + + getLog().info("Found " + dataFormatFiles.size() + " dataformat.properties files"); + getLog().info("Found " + jsonFiles.size() + " dataformat json files"); + + // make sure to create out dir + dataFormatsOutDir.mkdirs(); + + for (File file : jsonFiles) { + File to = new File(dataFormatsOutDir, file.getName()); + try { + copyFile(file, to); + } catch (IOException e) { + throw new MojoFailureException("Cannot copy file from " + file + " -> " + to, e); + } + } + + File all = new File(dataFormatsOutDir, "../dataformats.properties"); + try { + FileOutputStream fos = new FileOutputStream(all, false); + + String[] names = dataFormatsOutDir.list(); + List<String> dataFormats = new ArrayList<String>(); + // sort the names + for (String name : names) { + if (name.endsWith(".json")) { + // strip out .json from the name + String dataFormatName = name.substring(0, name.length() - 5); + dataFormats.add(dataFormatName); + } + } + + Collections.sort(dataFormats); + for (String name : dataFormats) { + fos.write(name.getBytes()); + fos.write("\n".getBytes()); + } + + fos.close(); + + } catch (IOException e) { + throw new MojoFailureException("Error writing to file " + all); + } + } + + protected void executeLanguages(Set<String> starters) throws MojoExecutionException, MojoFailureException { + getLog().info("Copying all Camel language json descriptors"); + + // lets use sorted set/maps + Set<File> jsonFiles = new TreeSet<File>(); + Set<File> languageFiles = new TreeSet<File>(); + + // find all languages from the components directory + if (componentsDir != null && componentsDir.isDirectory()) { + File[] languages = componentsDir.listFiles(); + if (languages != null) { + for (File dir : languages) { + // skip camel-spring-dm + if (dir.isDirectory() && "camel-spring-dm".equals(dir.getName())) { + continue; + } + // the directory must be in the list of known features + if (!starters.contains(dir.getName())) { + continue; + } + if (dir.isDirectory() && !"target".equals(dir.getName())) { + File target = new File(dir, "target/classes"); + findLanguageFilesRecursive(target, jsonFiles, languageFiles, new CamelLanguagesFileFilter()); + } + } + } + } + if (coreDir != null && coreDir.isDirectory()) { + File target = new File(coreDir, "target/classes"); + findLanguageFilesRecursive(target, jsonFiles, languageFiles, new CamelLanguagesFileFilter()); + } + + getLog().info("Found " + languageFiles.size() + " language.properties files"); + getLog().info("Found " + jsonFiles.size() + " language json files"); + + // make sure to create out dir + languagesOutDir.mkdirs(); + + for (File file : jsonFiles) { + File to = new File(languagesOutDir, file.getName()); + try { + copyFile(file, to); + } catch (IOException e) { + throw new MojoFailureException("Cannot copy file from " + file + " -> " + to, e); + } + } + + File all = new File(languagesOutDir, "../languages.properties"); + try { + FileOutputStream fos = new FileOutputStream(all, false); + + String[] names = languagesOutDir.list(); + List<String> languages = new ArrayList<String>(); + // sort the names + for (String name : names) { + if (name.endsWith(".json")) { + // strip out .json from the name + String languageName = name.substring(0, name.length() - 5); + languages.add(languageName); + } + } + + Collections.sort(languages); + for (String name : languages) { + fos.write(name.getBytes()); + fos.write("\n".getBytes()); + } + + fos.close(); + + } catch (IOException e) { + throw new MojoFailureException("Error writing to file " + all); + } + } + + private void findComponentFilesRecursive(File dir, Set<File> found, Set<File> components, FileFilter filter) { + File[] files = dir.listFiles(filter); + if (files != null) { + for (File file : files) { + // skip files in root dirs as Camel does not store information there but others may do + boolean rootDir = "classes".equals(dir.getName()) || "META-INF".equals(dir.getName()); + boolean jsonFile = !rootDir && file.isFile() && file.getName().endsWith(".json"); + boolean componentFile = !rootDir && file.isFile() && file.getName().equals("component.properties"); + if (jsonFile) { + found.add(file); + } else if (componentFile) { + components.add(file); + } else if (file.isDirectory()) { + findComponentFilesRecursive(file, found, components, filter); + } + } + } + } + + private void findDataFormatFilesRecursive(File dir, Set<File> found, Set<File> dataFormats, FileFilter filter) { + File[] files = dir.listFiles(filter); + if (files != null) { + for (File file : files) { + // skip files in root dirs as Camel does not store information there but others may do + boolean rootDir = "classes".equals(dir.getName()) || "META-INF".equals(dir.getName()); + boolean jsonFile = !rootDir && file.isFile() && file.getName().endsWith(".json"); + boolean dataFormatFile = !rootDir && file.isFile() && file.getName().equals("dataformat.properties"); + if (jsonFile) { + found.add(file); + } else if (dataFormatFile) { + dataFormats.add(file); + } else if (file.isDirectory()) { + findDataFormatFilesRecursive(file, found, dataFormats, filter); + } + } + } + } + + private void findLanguageFilesRecursive(File dir, Set<File> found, Set<File> languages, FileFilter filter) { + File[] files = dir.listFiles(filter); + if (files != null) { + for (File file : files) { + // skip files in root dirs as Camel does not store information there but others may do + boolean rootDir = "classes".equals(dir.getName()) || "META-INF".equals(dir.getName()); + boolean jsonFile = !rootDir && file.isFile() && file.getName().endsWith(".json"); + boolean languageFile = !rootDir && file.isFile() && file.getName().equals("language.properties"); + if (jsonFile) { + found.add(file); + } else if (languageFile) { + languages.add(file); + } else if (file.isDirectory()) { + findLanguageFilesRecursive(file, found, languages, filter); + } + } + } + } + + private class CamelComponentsFileFilter implements FileFilter { + + @Override + public boolean accept(File pathname) { + if (pathname.isDirectory() && pathname.getName().equals("model")) { + // do not check the camel-core model packages as there is no components there + return false; + } + if (pathname.isFile() && pathname.getName().endsWith(".json")) { + // must be a components json file + try { + String json = loadText(new FileInputStream(pathname)); + return json != null && json.contains("\"kind\": \"component\""); + } catch (IOException e) { + // ignore + } + } + return pathname.isDirectory() || (pathname.isFile() && pathname.getName().equals("component.properties")); + } + } + + private class CamelDataFormatsFileFilter implements FileFilter { + + @Override + public boolean accept(File pathname) { + if (pathname.isDirectory() && pathname.getName().equals("model")) { + // do not check the camel-core model packages as there is no components there + return false; + } + if (pathname.isFile() && pathname.getName().endsWith(".json")) { + // must be a dataformat json file + try { + String json = loadText(new FileInputStream(pathname)); + return json != null && json.contains("\"kind\": \"dataformat\""); + } catch (IOException e) { + // ignore + } + } + return pathname.isDirectory() || (pathname.isFile() && pathname.getName().equals("dataformat.properties")); + } + } + + private class CamelLanguagesFileFilter implements FileFilter { + + @Override + public boolean accept(File pathname) { + if (pathname.isDirectory() && pathname.getName().equals("model")) { + // do not check the camel-core model packages as there is no components there + return false; + } + if (pathname.isFile() && pathname.getName().endsWith(".json")) { + // must be a language json file + try { + String json = loadText(new FileInputStream(pathname)); + return json != null && json.contains("\"kind\": \"language\""); + } catch (IOException e) { + // ignore + } + } + return pathname.isDirectory() || (pathname.isFile() && pathname.getName().equals("language.properties")); + } + } + + public static void copyFile(File from, File to) throws IOException { + FileChannel in = null; + FileChannel out = null; + try { + in = new FileInputStream(from).getChannel(); + out = new FileOutputStream(to).getChannel(); + + long size = in.size(); + long position = 0; + while (position < size) { + position += in.transferTo(position, BUFFER_SIZE, out); + } + } finally { + if (in != null) { + in.close(); + } + if (out != null) { + out.close(); + } + } + } + + private Set<String> findSpringBootStarters() { + Set<String> answer = new LinkedHashSet<>(); + + String[] names = componentsStarterDir.list(); + if (names != null) { + for (String name : names) { + if (name.startsWith("camel-") && name.endsWith("-starter")) { + // remove ending -starter + String regular = name.substring(0, name.length() - 8); + answer.add(regular); + } + } + } + return answer; + } + +} \ No newline at end of file
