org.codehaus.mojo.license

Class DownloadLicensesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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 org.apache.maven.plugin.AbstractMojo
implements MavenProjectDependenciesConfigurator

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.

Since:

1.0

Version:

$Revision: 18291 $

Author:

Paul Gier

Field Summary

Fields

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

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

ROLE

Constructor Summary

Constructors

Constructor and Description
DownloadLicensesMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
String	getExcludedArtifacts()
String	getExcludedGroups()
List<String>	getExcludedScopes()
String	getIncludedArtifacts()
String	getIncludedGroups()
List<String>	getIncludedScopes()
boolean	isIncludeTransitiveDependencies()
boolean	isVerbose()
void	setExcludedScopes(String excludedScopes)

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 Detail

skipDownloadLicenses

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

A flag to skip the goal.

Since:

1.5

Constructor Detail

DownloadLicensesMojo

public DownloadLicensesMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

isIncludeTransitiveDependencies

public boolean isIncludeTransitiveDependencies()

Specified by:

isIncludeTransitiveDependencies in interface MavenProjectDependenciesConfigurator

Returns:

true if should include transitive dependencies, false to include only direct dependencies.

getExcludedScopes

public List<String> getExcludedScopes()

Specified by:

getExcludedScopes in interface MavenProjectDependenciesConfigurator

Returns:

list of scopes to exclude while loading dependencies, if null is setted, then include all scopes.

setExcludedScopes

public void setExcludedScopes(String excludedScopes)

getIncludedScopes

public List<String> getIncludedScopes()

Specified by:

getIncludedScopes in interface MavenProjectDependenciesConfigurator

Returns:

list of scopes to include while loading dependencies, if null is setted, then include all scopes.

getIncludedArtifacts

public String getIncludedArtifacts()

Specified by:

getIncludedArtifacts in interface MavenProjectDependenciesConfigurator

Returns:

a pattern to include dependencies by thier artificatId, if null is setted then include all artifacts.

getIncludedGroups

public String getIncludedGroups()

Specified by:

getIncludedGroups in interface MavenProjectDependenciesConfigurator

Returns:

a pattern to include dependencies by their groupId, if null is setted then include all artifacts.

getExcludedGroups

public String getExcludedGroups()

Specified by:

getExcludedGroups in interface MavenProjectDependenciesConfigurator

Returns:

a pattern to exclude dependencies by their artifactId, if null is setted the no exclude is done on artifactId.

getExcludedArtifacts

public String getExcludedArtifacts()

Specified by:

getExcludedArtifacts in interface MavenProjectDependenciesConfigurator

Returns:

a pattern to exclude dependencies by their groupId, if null is setted then no exclude is done on groupId.

isVerbose

public boolean isVerbose()

Specified by:

isVerbose in interface MavenProjectDependenciesConfigurator

Returns:

true if verbose mode is on, false otherwise.