This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 2e722fa25c92a7d1405404cb14d67fada6814110 Author: Claus Ibsen <[email protected]> AuthorDate: Tue Feb 4 12:39:46 2020 +0100 CAMEL-14484: Make XML routes loader using JAXB into its own module --- apache-camel/pom.xml | 4 + apache-camel/src/main/descriptors/common-bin.xml | 1 + bom/camel-bom/pom.xml | 5 + core/camel-core-engine/pom.xml | 8 +- .../impl/XMLRoutesDefinitionLoaderResolver.java | 6 +- core/camel-xml-jaxb/pom.xml | 58 ++++++ .../xml/jaxb/JaxbXMLRoutesDefinitionLoader.java} | 12 +- .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 15 ++ .../services/org/apache/camel/xmlroutes-loader | 18 ++ core/pom.xml | 1 + parent/pom.xml | 5 + 12 files changed, 326 insertions(+), 10 deletions(-) diff --git a/apache-camel/pom.xml b/apache-camel/pom.xml index 48f53b0..756bb35 100644 --- a/apache-camel/pom.xml +++ b/apache-camel/pom.xml @@ -120,6 +120,10 @@ <groupId>org.apache.camel</groupId> <artifactId>camel-xml-io</artifactId> </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-xml-jaxb</artifactId> + </dependency> <!-- NOTE: auto-generated list of components when building camel catalog --> <!-- camel components: START --> diff --git a/apache-camel/src/main/descriptors/common-bin.xml b/apache-camel/src/main/descriptors/common-bin.xml index 6c81f15..1e7e45a 100644 --- a/apache-camel/src/main/descriptors/common-bin.xml +++ b/apache-camel/src/main/descriptors/common-bin.xml @@ -45,6 +45,7 @@ <include>org.apache.camel:camel-headersmap</include> <include>org.apache.camel:camel-caffeine-lrucache</include> <include>org.apache.camel:camel-xml-io</include> + <include>org.apache.camel:camel-xml-jaxb</include> <!-- NOTE: auto-generated list of components when building camel catalog --> <!-- camel components: START --> diff --git a/bom/camel-bom/pom.xml b/bom/camel-bom/pom.xml index 85acd97..9e80bf1 100644 --- a/bom/camel-bom/pom.xml +++ b/bom/camel-bom/pom.xml @@ -1845,6 +1845,11 @@ </dependency> <dependency> <groupId>org.apache.camel</groupId> + <artifactId>camel-xml-jaxb</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> <artifactId>camel-xmlsecurity</artifactId> <version>${project.version}</version> </dependency> diff --git a/core/camel-core-engine/pom.xml b/core/camel-core-engine/pom.xml index ac2ba06..aeca054 100644 --- a/core/camel-core-engine/pom.xml +++ b/core/camel-core-engine/pom.xml @@ -68,10 +68,10 @@ <groupId>org.apache.camel</groupId> <artifactId>camel-base</artifactId> </dependency> - <dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-jaxp</artifactId> - </dependency> +<!-- <dependency>--> +<!-- <groupId>org.apache.camel</groupId>--> +<!-- <artifactId>camel-jaxp</artifactId>--> +<!-- </dependency>--> <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-management-api</artifactId> diff --git a/core/camel-core-engine/src/main/java/org/apache/camel/impl/XMLRoutesDefinitionLoaderResolver.java b/core/camel-core-engine/src/main/java/org/apache/camel/impl/XMLRoutesDefinitionLoaderResolver.java index f8ed367..822be8c 100644 --- a/core/camel-core-engine/src/main/java/org/apache/camel/impl/XMLRoutesDefinitionLoaderResolver.java +++ b/core/camel-core-engine/src/main/java/org/apache/camel/impl/XMLRoutesDefinitionLoaderResolver.java @@ -20,6 +20,8 @@ import java.io.IOException; import org.apache.camel.CamelContext; import org.apache.camel.ExtendedCamelContext; +import org.apache.camel.NoFactoryAvailableException; +import org.apache.camel.RuntimeCamelException; import org.apache.camel.spi.FactoryFinder; import org.apache.camel.spi.XMLRoutesDefinitionLoader; import org.slf4j.Logger; @@ -60,9 +62,7 @@ public class XMLRoutesDefinitionLoaderResolver { } } - // fallback to default - LOG.debug("Creating DefaultXMLRoutesDefinitionLoader"); - return new DefaultXMLRoutesDefinitionLoader(); + throw new RuntimeCamelException("Cannot find XML routes loader in classpath. Add either camel-xml-io or camel-xml-jaxb to the classpath."); } private Class<?> findFactory(String name, CamelContext context) throws IOException { diff --git a/core/camel-xml-jaxb/pom.xml b/core/camel-xml-jaxb/pom.xml new file mode 100644 index 0000000..b7eaaf5 --- /dev/null +++ b/core/camel-xml-jaxb/pom.xml @@ -0,0 +1,58 @@ +<?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/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.camel</groupId> + <artifactId>core</artifactId> + <version>3.1.0-SNAPSHOT</version> + </parent> + + <artifactId>camel-xml-jaxb</artifactId> + + <name>Camel :: XML JAXB</name> + <description>Camel XML JAXB</description> + + <dependencies> + + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-core-engine</artifactId> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-jaxp</artifactId> + </dependency> + + <!-- testing --> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-simple</artifactId> + <scope>test</scope> + </dependency> + </dependencies> + +</project> diff --git a/core/camel-core-engine/src/main/java/org/apache/camel/impl/DefaultXMLRoutesDefinitionLoader.java b/core/camel-xml-jaxb/src/main/java/org/apache/camel/xml/jaxb/JaxbXMLRoutesDefinitionLoader.java similarity index 94% rename from core/camel-core-engine/src/main/java/org/apache/camel/impl/DefaultXMLRoutesDefinitionLoader.java rename to core/camel-xml-jaxb/src/main/java/org/apache/camel/xml/jaxb/JaxbXMLRoutesDefinitionLoader.java index 650efea..24735ac 100644 --- a/core/camel-core-engine/src/main/java/org/apache/camel/impl/DefaultXMLRoutesDefinitionLoader.java +++ b/core/camel-xml-jaxb/src/main/java/org/apache/camel/xml/jaxb/JaxbXMLRoutesDefinitionLoader.java @@ -1,4 +1,4 @@ -package org.apache.camel.impl; +package org.apache.camel.xml.jaxb; import javax.xml.bind.Binder; import javax.xml.bind.JAXBContext; @@ -33,9 +33,10 @@ import org.w3c.dom.Node; import static org.apache.camel.model.ProcessorDefinitionHelper.filterTypeInOutputs; /** - * Default {@link XMLRoutesDefinitionLoader} which uses JAXB. + * JAXB based {@link XMLRoutesDefinitionLoader}. This is the default loader used historically by Camel. + * The camel-xml-io parser is a light-weight alternative. */ -public class DefaultXMLRoutesDefinitionLoader implements XMLRoutesDefinitionLoader { +public class JaxbXMLRoutesDefinitionLoader implements XMLRoutesDefinitionLoader { @Override public Object loadRoutesDefinition(CamelContext context, InputStream inputStream) throws Exception { @@ -98,6 +99,11 @@ public class DefaultXMLRoutesDefinitionLoader implements XMLRoutesDefinitionLoad return answer; } + @Override + public String toString() { + return "camel-xml-jaxb"; + } + private static JAXBContext getJAXBContext(CamelContext context) throws JAXBException { ModelJAXBContextFactory factory = context.adapt(ExtendedCamelContext.class).getModelJAXBContextFactory(); return factory.newJAXBContext(); diff --git a/core/camel-xml-jaxb/src/main/resources/META-INF/LICENSE.txt b/core/camel-xml-jaxb/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 0000000..6b0b127 --- /dev/null +++ b/core/camel-xml-jaxb/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/core/camel-xml-jaxb/src/main/resources/META-INF/NOTICE.txt b/core/camel-xml-jaxb/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 0000000..8547fe7 --- /dev/null +++ b/core/camel-xml-jaxb/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,15 @@ + ========================================================================= + == 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/). + + This product includes software developed by the Indiana + University Extreme! Lab. For further information please visit + http://www.extreme.indiana.edu/. + + Please read the different LICENSE files present in the licenses directory of + this distribution. diff --git a/core/camel-xml-jaxb/src/main/resources/META-INF/services/org/apache/camel/xmlroutes-loader b/core/camel-xml-jaxb/src/main/resources/META-INF/services/org/apache/camel/xmlroutes-loader new file mode 100644 index 0000000..47af26b --- /dev/null +++ b/core/camel-xml-jaxb/src/main/resources/META-INF/services/org/apache/camel/xmlroutes-loader @@ -0,0 +1,18 @@ +# +# 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. +# + +class=org.apache.camel.xml.jaxb.JaxbXMLRoutesDefinitionLoader diff --git a/core/pom.xml b/core/pom.xml index c1cceaa..1450097 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -45,6 +45,7 @@ <module>camel-jaxp</module> <module>camel-core-engine</module> <module>camel-xml-io</module> + <module>camel-xml-jaxb</module> <module>camel-core</module> <module>camel-endpointdsl</module> <module>camel-componentdsl</module> diff --git a/parent/pom.xml b/parent/pom.xml index eb3a7d1..1197559 100644 --- a/parent/pom.xml +++ b/parent/pom.xml @@ -832,6 +832,11 @@ <artifactId>camel-xml-io</artifactId> <version>${project.version}</version> </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-xml-jaxb</artifactId> + <version>${project.version}</version> + </dependency> <!-- NOTE: auto-generated list of components when building camel catalog --> <!-- camel components: START -->
