Author: jstrachan Date: Wed Oct 31 16:09:22 2012 New Revision: 1404218 URL: http://svn.apache.org/viewvc?rev=1404218&view=rev Log: added a simple camel maven plugin to generate a META-INF/services/org/apache/camel/component.properties file in each jar which contains a camel component (we could do the same trick for languages too) so we can easily auto-detect components on the classpath
Added: camel/trunk/tooling/maven/camel-package-maven-plugin/ camel/trunk/tooling/maven/camel-package-maven-plugin/pom.xml (with props) camel/trunk/tooling/maven/camel-package-maven-plugin/src/ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PackageMojo.java (with props) camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/LICENSE.txt (with props) camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/NOTICE.txt (with props) Modified: camel/trunk/camel-core/pom.xml camel/trunk/components/pom.xml camel/trunk/tooling/maven/pom.xml Modified: camel/trunk/camel-core/pom.xml URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/pom.xml?rev=1404218&r1=1404217&r2=1404218&view=diff ============================================================================== --- camel/trunk/camel-core/pom.xml (original) +++ camel/trunk/camel-core/pom.xml Wed Oct 31 16:09:22 2012 @@ -159,6 +159,20 @@ <forkedProcessTimeoutInSeconds>3000</forkedProcessTimeoutInSeconds> </configuration> </plugin> + + <plugin> + <groupId>org.apache.camel</groupId> + <artifactId>camel-package-maven-plugin</artifactId> + <version>${project.version}</version> + <executions> + <execution> + <goals> + <goal>package</goal> + </goals> + <phase>compile</phase> + </execution> + </executions> + </plugin> </plugins> </build> Modified: camel/trunk/components/pom.xml URL: http://svn.apache.org/viewvc/camel/trunk/components/pom.xml?rev=1404218&r1=1404217&r2=1404218&view=diff ============================================================================== --- camel/trunk/components/pom.xml (original) +++ camel/trunk/components/pom.xml Wed Oct 31 16:09:22 2012 @@ -169,4 +169,21 @@ <module>camel-zookeeper</module> </modules> + <build> + <plugins> + <plugin> + <groupId>org.apache.camel</groupId> + <artifactId>camel-package-maven-plugin</artifactId> + <version>${project.version}</version> + <executions> + <execution> + <goals> + <goal>package</goal> + </goals> + <phase>compile</phase> + </execution> + </executions> + </plugin> + </plugins> + </build> </project> Added: camel/trunk/tooling/maven/camel-package-maven-plugin/pom.xml URL: http://svn.apache.org/viewvc/camel/trunk/tooling/maven/camel-package-maven-plugin/pom.xml?rev=1404218&view=auto ============================================================================== --- camel/trunk/tooling/maven/camel-package-maven-plugin/pom.xml (added) +++ camel/trunk/tooling/maven/camel-package-maven-plugin/pom.xml Wed Oct 31 16:09:22 2012 @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.camel</groupId> + <artifactId>maven-plugins</artifactId> + <version>2.11-SNAPSHOT</version> + </parent> + + <artifactId>camel-package-maven-plugin</artifactId> + <packaging>maven-plugin</packaging> + <name>Camel :: Maven Plugins :: Camel Package</name> + <description>Maven plugin to help package Camel components and plugins</description> + + <dependencies> +<!-- + <dependency> + <groupId>org.codehaus.mojo</groupId> + <artifactId>exec-maven-plugin</artifactId> + </dependency> +--> + <dependency> + <groupId>org.codehaus.plexus</groupId> + <artifactId>plexus-utils</artifactId> + </dependency> +<!-- + <dependency> + <groupId>org.codehaus.plexus</groupId> + <artifactId>plexus-container-default</artifactId> + </dependency> + + <dependency> + <groupId>org.apache.maven.reporting</groupId> + <artifactId>maven-reporting-api</artifactId> + </dependency> + <dependency> + <groupId>org.apache.maven.reporting</groupId> + <artifactId>maven-reporting-impl</artifactId> + </dependency> +--> + + <!-- add some logging to the classpath --> + <dependency> + <groupId>log4j</groupId> + <artifactId>log4j</artifactId> + </dependency> + <dependency> + <groupId>org.slf4j</groupId> + <artifactId>slf4j-log4j12</artifactId> + </dependency> + </dependencies> +</project> Propchange: camel/trunk/tooling/maven/camel-package-maven-plugin/pom.xml ------------------------------------------------------------------------------ svn:eol-style = native Added: camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PackageMojo.java URL: http://svn.apache.org/viewvc/camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PackageMojo.java?rev=1404218&view=auto ============================================================================== --- camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PackageMojo.java (added) +++ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PackageMojo.java Wed Oct 31 16:09:22 2012 @@ -0,0 +1,98 @@ +/** + * 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.maven.packaging; + +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 java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.util.Properties; + +/** + * Analyses the Camel plugins in a project and generates extra descriptor information for easier auto-discovery in Camel. + * + * @goal package + * @execute phase="compile" + */ +public class PackageMojo extends AbstractMojo { + + /** + * The maven project. + * + * @parameter expression="${project}" + * @required + * @readonly + */ + protected MavenProject project; + + /** + * The output directory of classes + * + * @parameter expression="${project.build.directory}/classes" + * @readonly + */ + protected File outDir; + + + /** + * 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 { + File camelMetaDir = new File(outDir, "META-INF/services/org/apache/camel"); + File componentMetaDir = new File(camelMetaDir, "component"); + if (!componentMetaDir.exists()) { + getLog().warn("No " + componentMetaDir + " directory found. Are you sure you have created a Camel component?"); + } else { + File[] files = componentMetaDir.listFiles(); + if (files != null) { + Properties properties = new Properties(); + StringBuffer buffer = new StringBuffer(); + for (File file : files) { + String name = file.getName(); + if (buffer.length() > 0) { + buffer.append(" "); + } + buffer.append(name); + } + String names = buffer.toString(); + properties.put("components", names); + properties.put("groupId", project.getGroupId()); + properties.put("artifactId", project.getArtifactId()); + properties.put("version", project.getVersion()); + properties.put("projectName", project.getName()); + properties.put("projectDescription", project.getDescription()); + + File outFile = new File(camelMetaDir, "component.properties"); + try { + properties.store(new FileWriter(outFile), "Generated by camel-package-maven-plugin"); + getLog().info("Generated " + outFile + " containing camel components " + names); + } catch (IOException e) { + throw new MojoExecutionException("Failed to write properties to " + outFile + ". Reason: " + e, e); + } + } + } + } + +} Propchange: camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PackageMojo.java ------------------------------------------------------------------------------ svn:eol-style = native Added: camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/LICENSE.txt URL: http://svn.apache.org/viewvc/camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/LICENSE.txt?rev=1404218&view=auto ============================================================================== --- camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/LICENSE.txt (added) +++ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/LICENSE.txt Wed Oct 31 16:09:22 2012 @@ -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. + Propchange: camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/LICENSE.txt ------------------------------------------------------------------------------ svn:eol-style = native Added: camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/NOTICE.txt URL: http://svn.apache.org/viewvc/camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/NOTICE.txt?rev=1404218&view=auto ============================================================================== --- camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/NOTICE.txt (added) +++ camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/NOTICE.txt Wed Oct 31 16:09:22 2012 @@ -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. Propchange: camel/trunk/tooling/maven/camel-package-maven-plugin/src/main/resources/META-INF/NOTICE.txt ------------------------------------------------------------------------------ svn:eol-style = native Modified: camel/trunk/tooling/maven/pom.xml URL: http://svn.apache.org/viewvc/camel/trunk/tooling/maven/pom.xml?rev=1404218&r1=1404217&r2=1404218&view=diff ============================================================================== --- camel/trunk/tooling/maven/pom.xml (original) +++ camel/trunk/tooling/maven/pom.xml Wed Oct 31 16:09:22 2012 @@ -30,6 +30,7 @@ <packaging>pom</packaging> <modules> + <module>camel-package-maven-plugin</module> <module>camel-maven-plugin</module> <module>guice-maven-plugin</module> <module>maven-html-to-pdf</module>