Package org.codehaus.mojo.license

Class DownloadLicensesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.license.AbstractLicensesXmlMojo

org.codehaus.mojo.license.AbstractDownloadLicensesMojo

org.codehaus.mojo.license.DownloadLicensesMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, MavenProjectDependenciesConfigurator

@Mojo(name="download-licenses",
      requiresDependencyResolution=TEST,
      defaultPhase=PACKAGE)
public class DownloadLicensesMojo
extends AbstractDownloadLicensesMojo

Download the license files of all the current project's dependencies, and generate a summary file containing a list of all dependencies and their licenses.

The license files will be downloaded to AbstractDownloadLicensesMojo.licensesOutputDirectory to be included in the final packaging of the project if desired. The licenses are downloaded from the url field of the dependency POM.

If the license information (license name and license URL) is missing or otherwise broken in a dependency POM, this mojo offers several fallback options:

• AbstractDownloadLicensesMojo.licensesConfigFile
• AbstractDownloadLicensesMojo.errorRemedy
• AbstractDownloadLicensesMojo.licenseUrlReplacements
• AbstractDownloadLicensesMojo.licenseUrlFileNames

Since:

1.0

Author:

Paul Gier

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

AbstractDownloadLicensesMojo.ErrorRemedy

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	skipDownloadLicenses	A flag to skip the goal.

Fields inherited from class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

errorRemedy, licensesCalcOutputFile, licensesConfigFile, licensesExcelOutputFile, licensesOutputDirectory, licenseUrlFileNames, licenseUrlFileNameSanitizers, licenseUrlReplacements, organizeLicensesByDependencies, project, remoteRepositories, useDefaultUrlReplacements

Fields inherited from class org.codehaus.mojo.license.AbstractLicensesXmlMojo

licensedArtifactResolver, licensesOutputFile, licensesOutputFileEol

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
DownloadLicensesMojo(LicensedArtifactResolver licensedArtifactResolver)

Method Summary

Modifier and Type	Method	Description
protected Map<String,LicensedArtifact>	getDependencies()
protected boolean	isSkip()

Methods inherited from class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

execute, getArtifactFilters, getAutodetectEolFiles, getProject, isExcludeTransitiveDependencies, isIncludeTransitiveDependencies, isVerbose

Methods inherited from class org.codehaus.mojo.license.AbstractLicensesXmlMojo

getEncoding, writeLicenseSummary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

skipDownloadLicenses

@Parameter(property="license.skipDownloadLicenses",
           defaultValue="false")
protected boolean skipDownloadLicenses

A flag to skip the goal.

Since:

1.5

Constructor Details

DownloadLicensesMojo

@Inject
public DownloadLicensesMojo(LicensedArtifactResolver licensedArtifactResolver)

Method Details

isSkip

protected boolean isSkip()

Specified by:

isSkip in class AbstractDownloadLicensesMojo

getDependencies

protected Map<String,LicensedArtifact> getDependencies()

Specified by:

getDependencies in class AbstractDownloadLicensesMojo