org.codehaus.mojo.license

Class AddThirdPartyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.license.AbstractLicenseMojo

org.codehaus.mojo.license.AbstractAddThirdPartyMojo

org.codehaus.mojo.license.AddThirdPartyMojo

All Implemented Interfaces:

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

@Mojo(name="add-third-party",
      requiresProject=true,
      requiresDependencyResolution=TEST,
      defaultPhase=GENERATE_RESOURCES)
public class AddThirdPartyMojo
extends AbstractAddThirdPartyMojo
implements MavenProjectDependenciesConfigurator

Goal to generate the third-party license file.

This file contains a list of the dependencies and their licenses. Each dependency and its license is displayed on a single line in the format

   (<license-name>) <project-name> <groupId>:<artifactId>:<version> - <project-url>
 

The directory containing the license database file is added to the classpath as an additional resource.

Since:

1.0

Author:

tchemit

Nested Class Summary

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

AbstractAddThirdPartyMojo.ExcludedLicenses, AbstractAddThirdPartyMojo.IncludedLicenses

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AddThirdPartyMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkPackaging() Check if the project packaging is acceptable for the mojo.
protected boolean	checkSkip() Checks if the mojo execution should be skipped.
protected SortedProperties	createUnsafeMapping() Creates the unsafe mapping (says dependencies with no license given by their pom).
protected void	doAction() Do plugin action.
String	getExcludedArtifacts()
String	getExcludedGroups()
List<String>	getExcludedScopes()
String	getIncludedArtifacts()
String	getIncludedGroups()
List<String>	getIncludedScopes()
boolean	isIncludeTransitiveDependencies()
boolean	isSkip() When is sets to true, will skip execution.
protected SortedMap<String,org.apache.maven.project.MavenProject>	loadDependencies() Loads the dependencies of the project (as MavenProject, indexed by their gav.

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

checkForbiddenLicenses, checkUnsafeDependencies, getExcludedLicenses, getHelper, getIncludedLicenses, getLicenseMap, getMissingFile, getOutputDirectory, getProjectDependencies, getUnsafeDependencies, getUnsafeMappings, init, isDoGenerate, isDoGenerateBundle, isFailIfWarning, isForce, isUseMissingFile, setExcludedLicenses, setIncludedLicenses, writeThirdPartyFile

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

acceptPackaging, addResourceDir, afterExecute, checkEncoding, execute, getBuildTimestamp, getEncoding, getProject, getSession, hasClassPath, isVerbose, rejectPackaging, setEncoding, setVerbose

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

Methods inherited from interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator

isVerbose

Constructor Detail

AddThirdPartyMojo

public AddThirdPartyMojo()

Method Detail

isSkip

public boolean isSkip()

When is sets to true, will skip execution.

This will take effect in at the very begin of the AbstractLicenseMojo.execute() before any initialisation of goal.

Specified by:

isSkip in class AbstractLicenseMojo

Returns:

true if goal will not be executed

checkPackaging

protected boolean checkPackaging()

Check if the project packaging is acceptable for the mojo.

By default, accept all packaging types.

Note: This method is the first instruction to be executed in the AbstractLicenseMojo.execute().

Tip: There is two method to simplify the packaging check :

AbstractLicenseMojo.acceptPackaging(String...)

and

AbstractLicenseMojo.rejectPackaging(String...)

Overrides:

checkPackaging in class AbstractLicenseMojo

Returns:

true if can execute the goal for the packaging of the project, false otherwise.

checkSkip

protected boolean checkSkip()

Checks if the mojo execution should be skipped.

Overrides:

checkSkip in class AbstractLicenseMojo

Returns:

false if the mojo should not be executed.

doAction

protected void doAction()
                 throws Exception

Do plugin action.

The method AbstractLicenseMojo.execute() invoke this method only and only if :

• AbstractLicenseMojo.checkPackaging() returns true.
• method AbstractLicenseMojo.init() returns true.

Specified by:

doAction in class AbstractLicenseMojo

Throws:

Exception - if any

loadDependencies

protected SortedMap<String,org.apache.maven.project.MavenProject> loadDependencies()

Loads the dependencies of the project (as MavenProject, indexed by their gav.

Specified by:

loadDependencies in class AbstractAddThirdPartyMojo

Returns:

the map of dependencies of the maven project indexed by their gav.

createUnsafeMapping

protected SortedProperties createUnsafeMapping()
                                        throws org.apache.maven.project.ProjectBuildingException,
                                               IOException,
                                               ThirdPartyToolException

Creates the unsafe mapping (says dependencies with no license given by their pom).

Can come from loaded missing file or from dependencies with no license at all.

Specified by:

createUnsafeMapping in class AbstractAddThirdPartyMojo

Returns:

the map of usafe mapping indexed by their gav.

Throws:

org.apache.maven.project.ProjectBuildingException - if could not create maven porject for some dependencies

IOException - if could not load missing file

ThirdPartyToolException - for third party tool error

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.

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.

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.

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.

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.

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.

isIncludeTransitiveDependencies

public boolean isIncludeTransitiveDependencies()

Specified by:

isIncludeTransitiveDependencies in interface MavenProjectDependenciesConfigurator

Returns:

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