#47 - Added configurable license text support

CycloneDX · Feb 7, 2020 · 53f95ce · 53f95ce
1 parent 2c8f58d
commit 53f95ce
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ Maven Usage
     <plugin>
         <groupId>org.cyclonedx</groupId>
         <artifactId>cyclonedx-maven-plugin</artifactId>
-        <version>1.6.3</version>
+        <version>1.6.4</version>
     </plugin>
 </plugins>
 ```
@@ -35,7 +35,7 @@ Default Values
     <plugin>
         <groupId>org.cyclonedx</groupId>
         <artifactId>cyclonedx-maven-plugin</artifactId>
-        <version>1.6.3</version>
+        <version>1.6.4</version>
         <executions>
             <execution>
                 <phase>verify</phase>
@@ -52,6 +52,7 @@ Default Values
             <includeRuntimeScope>true</includeRuntimeScope>
             <includeSystemScope>true</includeSystemScope>
             <includeTestScope>false</includeTestScope>
+            <includeLicenseText>true</includeLicenseText>
             <includeDependencyGraph>true</includeDependencyGraph>
         </configuration>
     </plugin>

diff --git a/pom.xml b/pom.xml
@@ -99,7 +99,7 @@
         <dependency>
             <groupId>org.cyclonedx</groupId>
             <artifactId>cyclonedx-core-java</artifactId>
-            <version>2.6.4</version>
+            <version>2.6.5</version>
         </dependency>
         <dependency>
             <groupId>org.apache.maven</groupId>

diff --git a/src/main/java/org/cyclonedx/maven/BaseCycloneDxMojo.java b/src/main/java/org/cyclonedx/maven/BaseCycloneDxMojo.java
@@ -107,6 +107,9 @@ public abstract class BaseCycloneDxMojo extends AbstractMojo {
     @Parameter(property = "includeDependencyGraph", defaultValue = "true", required = false)
     private Boolean includeDependencyGraph;
 
+    @Parameter(property = "includeLicenseText", defaultValue = "true", required = false)
+    private Boolean includeLicenseText;
+
     @Parameter(property = "excludeTypes", required = false)
     private String[] excludeTypes;
 
@@ -234,6 +237,16 @@ public Boolean getIncludeDependencyGraph() {
         return includeDependencyGraph;
     }
 
+    /**
+     * Returns if license text should be included in bom.
+     *
+     * @return true if license text should be included, otherwise false
+     */
+    public Boolean getIncludeLicenseText() {
+        return includeLicenseText;
+    }
+
+
     /**
      * Returns if excluded types are defined.
      *
@@ -448,7 +461,7 @@ private LicenseChoice resolveMavenLicenses(final List<org.apache.maven.model.Lic
         for (org.apache.maven.model.License artifactLicense : projectLicenses) {
             boolean resolved = false;
             if (artifactLicense.getName() != null) {
-                final LicenseChoice resolvedByName = LicenseResolver.resolve(artifactLicense.getName());
+                final LicenseChoice resolvedByName = LicenseResolver.resolve(artifactLicense.getName(), includeLicenseText);
                 if (resolvedByName != null) {
                     if (resolvedByName.getLicenses() != null && !resolvedByName.getLicenses().isEmpty()) {
                         resolved = true;
@@ -460,7 +473,7 @@ private LicenseChoice resolveMavenLicenses(final List<org.apache.maven.model.Lic
                 }
             }
             if (artifactLicense.getUrl() != null && !resolved) {
-                final LicenseChoice resolvedByUrl = LicenseResolver.resolve(artifactLicense.getUrl());
+                final LicenseChoice resolvedByUrl = LicenseResolver.resolve(artifactLicense.getUrl(), includeLicenseText);
                 if (resolvedByUrl != null) {
                     if (resolvedByUrl.getLicenses() != null && !resolvedByUrl.getLicenses().isEmpty()) {
                         resolved = true;
@@ -701,6 +714,8 @@ protected void logParameters() {
             getLog().info("includeRuntimeScope    : " + includeRuntimeScope);
             getLog().info("includeTestScope       : " + includeTestScope);
             getLog().info("includeSystemScope     : " + includeSystemScope);
+            getLog().info("includeLicenseText     : " + includeLicenseText);
+            getLog().info("includeDependencyGraph : " + includeDependencyGraph);
             getLog().info("------------------------------------------------------------------------");
         }
     }