This is an automated email from the ASF dual-hosted git repository. simonetripodi pushed a commit to branch product-packaging in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-feature-analyser.git
commit 980d3ac14ad81eeb348e5a9d3ac5c62748508e27 Author: Simo Tripodi <[email protected]> AuthorDate: Sat Sep 15 12:32:27 2018 +0200 SLING-7929 - Create a distribution package for the Feature Analyser initial checkin --- pom.xml | 109 +++++++--- src/main/assembly/README.md | 144 +++++++++++++ src/main/assembly/bin.xml | 67 ++++++ .../apache/sling/feature/analyser/main/Main.java | 163 ++++++++++---- .../sling/feature/analyser/main/ShutDownHook.java | 87 ++++++++ src/main/legal/LICENSE-with-deps | 233 +++++++++++++++++++++ src/main/legal/NOTICE-with-deps | 5 + src/main/legal/license-header | 14 ++ 8 files changed, 749 insertions(+), 73 deletions(-) diff --git a/pom.xml b/pom.xml index 6511b76..ec0a461 100644 --- a/pom.xml +++ b/pom.xml @@ -43,37 +43,6 @@ <build> <plugins> <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-dependency-plugin</artifactId> - <executions> - <execution> - <id>unpack-dependencies</id> - <phase>prepare-package</phase> - <goals> - <goal>unpack-dependencies</goal> - </goals> - <configuration> - <excludes>META-INF/**</excludes> - <outputDirectory>${project.build.directory}/classes</outputDirectory> - <overWriteReleases>false</overWriteReleases> - <overWriteSnapshots>true</overWriteSnapshots> - <includeArtifactIds>commons-cli,commons-lang,org.apache.felix.utils,org.apache.felix.converter,org.apache.sling.feature,org.apache.sling.feature.io,org.apache.sling.commons.johnzon,osgi.core,slf4j-api,slf4j-simple</includeArtifactIds> - </configuration> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-jar-plugin</artifactId> - <configuration> - <archive> - <manifest> - <mainClass>org.apache.sling.feature.analyser.main.Main</mainClass> - </manifest> - </archive> - </configuration> - </plugin> - <plugin> <groupId>org.apache.rat</groupId> <artifactId>apache-rat-plugin</artifactId> <configuration> @@ -85,13 +54,85 @@ </excludes> </configuration> </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>license-maven-plugin</artifactId> + <version>1.16</version> + <executions> + <execution> + <id>add-third-party</id> + <phase>generate-resources</phase> + <goals> + <goal>add-third-party</goal> + </goals> + <configuration> + <fileTemplate>${basedir}/src/main/legal/LICENSE-with-deps</fileTemplate> + <thirdPartyFilename>LICENSE-with-deps</thirdPartyFilename> + <sortArtifactByName>true</sortArtifactByName> + <excludedScopes>test</excludedScopes> + <licenseMerges> + <licenseMerge>The Apache Software License, Version 2.0|Apache License, Version 2.0|Apache Public License 2.0</licenseMerge> + </licenseMerges> + </configuration> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>appassembler-maven-plugin</artifactId> + <version>2.0.0</version> + <executions> + <execution> + <phase>package</phase> + <goals> + <goal>assemble</goal> + </goals> + </execution> + </executions> + <configuration> + <repositoryLayout>flat</repositoryLayout> + <repositoryName>lib</repositoryName> + <useWildcardClassPath>true</useWildcardClassPath> + <extraJvmArguments>-Dproject.artifactId=${project.artifactId} -Dproject.version=${project.version} -Dbuild.timestamp=${maven.build.timestamp} -Duser.timezone=UTC -Dfile.encoding=UTF-8</extraJvmArguments> + <defaultJvmSettings>-Xms500m -Xmx500m -XX:PermSize=128m -XX:-UseGCOverheadLimit</defaultJvmSettings> + <licenseHeaderFile>${basedir}/src/main/legal/license-header</licenseHeaderFile> + <programs> + <program> + <mainClass>org.apache.sling.feature.analyser.main.Main</mainClass> + <name>sfa</name> + </program> + </programs> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-assembly-plugin</artifactId> + <version>3.1.0</version> + <executions> + <execution> + <id>assembly</id> + <phase>package</phase> + <goals> + <goal>single</goal> + </goals> + </execution> + </executions> + <configuration> + <finalName>${project.build.finalName}</finalName> + <tarLongFileMode>gnu</tarLongFileMode> + <appendAssemblyId>false</appendAssemblyId> + <descriptors> + <descriptor>${basedir}/src/main/assembly/bin.xml</descriptor> + </descriptors> + </configuration> + </plugin> </plugins> </build> <dependencies> <dependency> - <groupId>commons-cli</groupId> - <artifactId>commons-cli</artifactId> - <version>1.3.1</version> + <groupId>io.airlift</groupId> + <artifactId>airline</artifactId> + <version>0.8</version> <scope>provided</scope> </dependency> <dependency> diff --git a/src/main/assembly/README.md b/src/main/assembly/README.md new file mode 100644 index 0000000..168ccb0 --- /dev/null +++ b/src/main/assembly/README.md @@ -0,0 +1,144 @@ +``` +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.name} - ${project.inceptionYear} + +## What is it? + + ${project.description} + +## Licensing + + Please see the files called LICENSE and NOTICE + +## Documentation + + The most up-to-date documentation can be found at ${project.url}. + +## Useful URLs + + Home Page: ${project.url}/ + Source Code: ${project.scm.url} + Issue Tracking: ${project.issueManagement.url} + +## System Requirements + +### JDK + + ${sling.java.version} or above. (see http://www.oracle.com/technetwork/java/) + +### Memory + + No minimum requirement. + +### Disk + + No minimum requirement. + +### Operating System + + No minimum requirement. On Windows, Windows NT and above or Cygwin is required for + the startup scripts. Tested on Windows XP, Fedora Core and Mac OS X. + +--- + +## Installation + +### Windows 2000/XP + + 1) Unzip the distribution archive, i.e. `${project.build.finalName}.zip` to the directory you wish to install `${project.name} ${project.version}`. +These instructions assume you chose `C:\Program Files`. +The subdirectory `${project.build.finalName}` will be created from the archive. + + 2) Add the `SFA_HOME` environment variable by opening up the system properties (WinKey + Pause), selecting the "Advanced" tab, and the "Environment Variables" button, then adding the `SFA_HOME` variable in the user variables with the value `C:\Program Files\${project.build.finalName}`. + + 3) In the same dialog, add the SFA environment variable in the user variables with the value `%SFA_HOME%\bin`. + + 4) In the same dialog, update/create the _Path_ environment variable in the user variables and prepend the value `%SFA%` to add `${project.name}` available in the command line. + + 5) In the same dialog, make sure that `JAVA_HOME` exists in your user variables or in the system variables and it is set to the location of your JDK, e.g. `C:\Program Files\Java\1.8.0_152` and that `%JAVA_HOME%\bin` is in your _Path_ environment variable. + + 6) Open a new command prompt (Winkey + R then type cmd) and run `sfa --version` to verify that it is correctly installed. + +## Unix-based Operating Systems (Linux, Solaris and Mac OS X) + + 1) Extract the distribution archive, i.e. `${project.build.finalName}.tar.gz` to the directory you wish to install `${project.name} ${project.version}`. +These instructions assume you chose `/usr/local`. +The subdirectory `${project.build.finalName}` will be created from the archive. + + 2) In a command terminal, add the `SFA_HOME` environment variable, e.g. + `export SFA_HOME=/usr/local/${project.build.finalName}`. + + 3) Add the `SFA` environment variable, e.g. `export SFA=$SFA_HOME/bin`. + + 4) Add `SFA` environment variable to your path, e.g. `export PATH=$SFA:$PATH`. + + 5) Make sure that `JAVA_HOME` is set to the location of your JDK, e.g. `export JAVA_HOME=/usr/java/1.8.0_152` and that `$JAVA_HOME/bin` is in your `PATH` environment variable. + + 6) Run `sfa --version` to verify that it is correctly installed. + +--- + +## Execution + + Open the shell and type `sfa help` to see the available commands: + +``` +$ ./bin/sfa help +usage: sfa <command> [<args>] + +The most commonly used sfa commands are: + analyse Apache Sling Application Analyser + help Display help information + +See 'sfa help <command>' for more information on a specific command. +``` + + See the `analyse` options: + +``` +$ ./bin/sfa help analise +Unknown command analise + +MacBook-Pro:org.apache.sling.feature.analyser-0.1.3-SNAPSHOT stripodi$ ./bin/sfa help analyse +NAME + sfa analyse - Apache Sling Application Analyser + +SYNOPSIS + sfa analyse (-f <featureFile> | --feature-file <featureFile>) + [(-p <pluginClass> | --plugin-class <pluginClass>)] [(-q | --quiet)] + [(-v | --version)] [(-X | --verbose)] + +OPTIONS + -f <featureFile>, --feature-file <featureFile> + Set feature file. + + -p <pluginClass>, --plugin-class <pluginClass> + Explicitly specify plugin class to run, if ommitted the default + plugins are used + + -q, --quiet + Log errors only. + + -v, --version + Display version information. + + -X, --verbose + Produce execution debug output. +``` diff --git a/src/main/assembly/bin.xml b/src/main/assembly/bin.xml new file mode 100644 index 0000000..876f2ac --- /dev/null +++ b/src/main/assembly/bin.xml @@ -0,0 +1,67 @@ +<?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. +--> +<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.1"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.1 http://maven.apache.org/xsd/assembly-1.1.1.xsd";> + + <id>${project.build.finalName}</id> + <formats> + <format>tar.gz</format> + <format>zip</format> + </formats> + <includeBaseDirectory>true</includeBaseDirectory> + <baseDirectory>${project.build.finalName}</baseDirectory> + + <files> + <file> + <source>${basedir}/src/main/assembly/README.md</source> + <filtered>true</filtered> + <outputDirectory>/</outputDirectory> + <fileMode>666</fileMode> + </file> + + <!-- + | Use the N&L files which apply to the included dependencies + --> + <file> + <source>${project.build.directory}/generated-sources/license/LICENSE-with-deps</source> + <destName>LICENSE</destName> + </file> + <file> + <source>${basedir}/src/main/legal/NOTICE-with-deps</source> + <destName>NOTICE</destName> + </file> + </files> + + <fileSets> + <!-- + | shell scripts + --> + <fileSet> + <directory>${project.build.directory}/appassembler/bin/</directory> + <outputDirectory>/bin</outputDirectory> + <fileMode>755</fileMode> + <directoryMode>755</directoryMode> + </fileSet> + </fileSets> + + <dependencySets> + <dependencySet> + <outputDirectory>/lib</outputDirectory> + <scope>provided</scope> + <useTransitiveDependencies>true</useTransitiveDependencies> + <useProjectArtifact>true</useProjectArtifact> + </dependencySet> + </dependencySets> + +</assembly> diff --git a/src/main/java/org/apache/sling/feature/analyser/main/Main.java b/src/main/java/org/apache/sling/feature/analyser/main/Main.java index 348ec80..df65865 100644 --- a/src/main/java/org/apache/sling/feature/analyser/main/Main.java +++ b/src/main/java/org/apache/sling/feature/analyser/main/Main.java @@ -16,16 +16,11 @@ */ package org.apache.sling.feature.analyser.main; +import java.io.File; import java.io.FileReader; import java.io.IOException; +import java.util.TimeZone; -import org.apache.commons.cli.CommandLine; -import org.apache.commons.cli.CommandLineParser; -import org.apache.commons.cli.DefaultParser; -import org.apache.commons.cli.HelpFormatter; -import org.apache.commons.cli.Option; -import org.apache.commons.cli.Options; -import org.apache.commons.cli.ParseException; import org.apache.sling.feature.Feature; import org.apache.sling.feature.analyser.Analyser; import org.apache.sling.feature.io.ArtifactManagerConfig; @@ -34,55 +29,67 @@ import org.apache.sling.feature.scanner.Scanner; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -public class Main { - private static String featureFile; - private static String pluginClass; +import io.airlift.airline.Cli; +import io.airlift.airline.Command; +import io.airlift.airline.Help; +import io.airlift.airline.Option; - private static void parseArgs(final String[] args) { - Option fileOption = new Option("f", true, "Set feature file"); - Option pluginOption = new Option("p", true, "Explicitly specify plugin class to run, " - + "if ommitted the default plugins are used"); +@Command(name = "analyse", description = "Apache Sling Application Analyser") +public class Main implements Runnable { - Options options = new Options(); - options.addOption(fileOption); - options.addOption(pluginOption); + @Option(name = { "-X", "--verbose" }, description = "Produce execution debug output.") + private boolean debug; - CommandLineParser parser = new DefaultParser(); - try { - CommandLine cl = parser.parse(options, args); + @Option(name = { "-q", "--quiet" }, description = "Log errors only.") + private boolean quiet; - featureFile = cl.getOptionValue(fileOption.getOpt()); - if (cl.hasOption(pluginOption.getOpt())) { - pluginClass = cl.getOptionValue(pluginOption.getOpt()); - } - } catch (ParseException e) { - HelpFormatter formatter = new HelpFormatter(); - formatter.printHelp("", options); - System.exit(1); - } - } + @Option(name = { "-v", "--version" }, description = "Display version information.") + private boolean printVersion; + + @Option(name = { "-f", "--feature-file" }, description = "Set feature file.", required = true) + private File featureFile; - public static void main(final String[] args) { + @Option(name = { "-p", "--plugin-class" }, description = "Explicitly specify plugin class to run, " + + "if ommitted the default plugins are used") + private String pluginClass; + + @Override + public void run() { // setup logging - System.setProperty("org.slf4j.simpleLogger.defaultLogLevel", "info"); + if (quiet) { + System.setProperty("org.slf4j.simpleLogger.defaultLogLevel", "error"); + } else if (debug) { + System.setProperty("org.slf4j.simpleLogger.defaultLogLevel", "debug"); + } else { + System.setProperty("org.slf4j.simpleLogger.defaultLogLevel", "info"); + } System.setProperty("org.slf4j.simpleLogger.showThreadName", "false"); System.setProperty("org.slf4j.simpleLogger.levelInBrackets", "true"); System.setProperty("org.slf4j.simpleLogger.showLogName", "false"); final Logger logger = LoggerFactory.getLogger("analyser"); - logger.info("Apache Sling Application Analyser"); - logger.info(""); - parseArgs(args); + // Add the Shutdown Hook to the Java virtual machine + // in order to destroy all the allocated resources + Runtime.getRuntime().addShutdownHook(new ShutDownHook(logger)); + + if (printVersion) { + printVersion(logger); + } + + String appName = getClass().getAnnotation(Command.class).description(); - if (featureFile == null) { - logger.error("Required argument missing: feature file"); + logger.info(appName); + logger.info(""); + + if (!featureFile.exists() || !featureFile.isFile()) { + logger.error("Feature file does not exist or is not a valid file"); System.exit(1); } Feature feature = null; try ( final FileReader r = new FileReader(featureFile)) { - feature = FeatureJSONReader.read(r, featureFile); + feature = FeatureJSONReader.read(r, featureFile.getAbsolutePath()); } catch ( final IOException ioe) { logger.error("Unable to read application: {}", featureFile, ioe); System.exit(1); @@ -97,9 +104,87 @@ public class Main { analyser = new Analyser(scanner); } analyser.analyse(feature); + + logger.info( "+-----------------------------------------------------+" ); + logger.info("{} SUCCESS", appName); } catch ( final Exception e) { - logger.error("Unable to analyse feature: {}", featureFile, e); + logger.info( "+-----------------------------------------------------+" ); + logger.info("{} FAILURE", appName); + logger.info( "+-----------------------------------------------------+" ); + + if (debug) { + logger.error("Unable to analyse feature {}:", featureFile, e); + } else { + logger.error("Unable to analyse feature {}: {}", featureFile, e.getMessage()); + } + + logger.info( "" ); + System.exit(1); } + + logger.info( "+-----------------------------------------------------+" ); + } + + private static void printVersion(final Logger logger) { + logger.info("{} v{} (built on {})", + System.getProperty("project.artifactId"), + System.getProperty("project.version"), + System.getProperty("build.timestamp")); + logger.info("Java version: {}, vendor: {}", + System.getProperty("java.version"), + System.getProperty("java.vendor")); + logger.info("Java home: {}", System.getProperty("java.home")); + logger.info("Default locale: {}_{}, platform encoding: {}", + System.getProperty("user.language"), + System.getProperty("user.country"), + System.getProperty("sun.jnu.encoding")); + logger.info("Default Time Zone: {}", TimeZone.getDefault()); + logger.info("OS name: \"{}\", version: \"{}\", arch: \"{}\", family: \"{}\"", + System.getProperty("os.name"), + System.getProperty("os.version"), + System.getProperty("os.arch"), + getOsFamily()); + logger.info("+-----------------------------------------------------+"); + } + + private static final String getOsFamily() { + String osName = System.getProperty("os.name").toLowerCase(); + String pathSep = System.getProperty("path.separator"); + + if (osName.indexOf("windows") != -1) { + return "windows"; + } else if (osName.indexOf("os/2") != -1) { + return "os/2"; + } else if (osName.indexOf("z/os") != -1 || osName.indexOf("os/390") != -1) { + return "z/os"; + } else if (osName.indexOf("os/400") != -1) { + return "os/400"; + } else if (pathSep.equals(";")) { + return "dos"; + } else if (osName.indexOf("mac") != -1) { + if (osName.endsWith("x")) { + return "mac"; // MACOSX + } + return "unix"; + } else if (osName.indexOf("nonstop_kernel") != -1) { + return "tandem"; + } else if (osName.indexOf("openvms") != -1) { + return "openvms"; + } else if (pathSep.equals(":")) { + return "unix"; + } + + return "undefined"; + } + + public static void main(String[] args) { + Cli.<Runnable>builder(System.getProperty("app.name")) + .withDescription("Apache Sling Feature analyser launcher") + .withDefaultCommand(Help.class) + .withCommands(Help.class, Main.class) + .build() + .parse(args) + .run(); } } diff --git a/src/main/java/org/apache/sling/feature/analyser/main/ShutDownHook.java b/src/main/java/org/apache/sling/feature/analyser/main/ShutDownHook.java new file mode 100644 index 0000000..e59a6a1 --- /dev/null +++ b/src/main/java/org/apache/sling/feature/analyser/main/ShutDownHook.java @@ -0,0 +1,87 @@ +/* + * 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.sling.feature.analyser.main; + +import java.util.Date; +import java.util.Formatter; + +import org.slf4j.Logger; + +final class ShutDownHook extends Thread { + + private final long start = System.currentTimeMillis(); + + private final Logger logger; + + public ShutDownHook(Logger logger) { + this.logger = logger; + } + + @Override + public void run() { + logger.info( "+-----------------------------------------------------+" ); + logger.info( "" ); + + // format the uptime string + + Formatter uptimeFormatter = new Formatter(); + uptimeFormatter.format( "Total time:" ); + + long uptime = System.currentTimeMillis() - start; + if ( uptime < 1000 ) + { + uptimeFormatter.format( " %s millisecond%s", uptime, ( uptime > 1 ? "s" : "" ) ); + } + else + { + long uptimeInSeconds = ( uptime ) / 1000; + final long hours = uptimeInSeconds / 3600; + + if ( hours > 0 ) + { + uptimeFormatter.format( " %s hour%s", hours, ( hours > 1 ? "s" : "" ) ); + } + + uptimeInSeconds = uptimeInSeconds - ( hours * 3600 ); + final long minutes = uptimeInSeconds / 60; + + if ( minutes > 0 ) + { + uptimeFormatter.format( " %s minute%s", minutes, ( minutes > 1 ? "s" : "" ) ); + } + + uptimeInSeconds = uptimeInSeconds - ( minutes * 60 ); + + if ( uptimeInSeconds > 0 ) + { + uptimeFormatter.format( " %s second%s", uptimeInSeconds, ( uptimeInSeconds > 1 ? "s" : "" ) ); + } + } + + logger.info( uptimeFormatter.toString() ); + uptimeFormatter.close(); + + logger.info( "Finished at: {}", new Date() ); + + final Runtime runtime = Runtime.getRuntime(); + final int megaUnit = 1024 * 1024; + logger.info( "Final Memory: {}M/{}M", + ( runtime.totalMemory() - runtime.freeMemory() ) / megaUnit, + runtime.totalMemory() / megaUnit ); + } + +} diff --git a/src/main/legal/LICENSE-with-deps b/src/main/legal/LICENSE-with-deps new file mode 100644 index 0000000..6dc1c4d --- /dev/null +++ b/src/main/legal/LICENSE-with-deps @@ -0,0 +1,233 @@ + + 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. + +<#function licenseFormat licenses> + <#assign result = ""/> + <#list licenses as license> + <#if result?length > 0> + <#assign result = result + ", " /> + </#if> + <#assign result = result + license /> + </#list> + <#return result> +</#function> + +<#function artifactFormat p> + <#if p.name?index_of('Unnamed') > -1> + <#return p.groupId + ":" + p.artifactId + ":" + p.version + " (" + (p.url!"no url defined") + ")"> + <#else> + <#return p.name + " v" + p.version + " (" + (p.url!"no url defined") + ")"> + </#if> +</#function> + +<#if dependencyMap?size == 0> +The project has no dependencies. +<#else> + <#list dependencyMap as e> + <#assign project = e.getKey()/> + <#assign licenses = e.getValue()/> +For the ${artifactFormat(project)} component +This is licensed under ${licenseFormat(licenses)} + + </#list> +</#if> \ No newline at end of file diff --git a/src/main/legal/NOTICE-with-deps b/src/main/legal/NOTICE-with-deps new file mode 100644 index 0000000..e7f7780 --- /dev/null +++ b/src/main/legal/NOTICE-with-deps @@ -0,0 +1,5 @@ +Apache Sling Feature Analyser +Copyright 2018 The Apache Software Foundation + +This product includes software developed by +The Apache Software Foundation (http://www.apache.org/). diff --git a/src/main/legal/license-header b/src/main/legal/license-header new file mode 100644 index 0000000..c2af574 --- /dev/null +++ b/src/main/legal/license-header @@ -0,0 +1,14 @@ + 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. \ No newline at end of file
