org.codehaus.mojo.license

Class AbstractAddThirdPartyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.license.AbstractLicenseMojo

org.codehaus.mojo.license.AbstractAddThirdPartyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AddThirdPartyMojo, AggregatorAddThirdPartyMojo

public abstract class AbstractAddThirdPartyMojo
extends AbstractLicenseMojo

Abstract mojo for all third-party mojos.

Since:

1.0

Author:

tchemit

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractAddThirdPartyMojo.ExcludedLicenses Class to fill the excludedLicenses parameter, from a simple string to split, or a list of string.
static class	AbstractAddThirdPartyMojo.IncludedLicenses Class to fill the includedLicenses parameter, from a simple string to split, or a list of string.

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractAddThirdPartyMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkForbiddenLicenses()
protected boolean	checkUnsafeDependencies()
protected abstract SortedProperties	createUnsafeMapping() Creates the unsafe mapping (says dependencies with no license given by their pom).
List<String>	getExcludedLicenses()
protected ThirdPartyHelper	getHelper()
List<String>	getIncludedLicenses()
LicenseMap	getLicenseMap()
File	getMissingFile()
File	getOutputDirectory()
SortedMap<String,org.apache.maven.project.MavenProject>	getProjectDependencies()
SortedSet<org.apache.maven.project.MavenProject>	getUnsafeDependencies()
SortedProperties	getUnsafeMappings()
protected void	init() Method to initialize the mojo before doing any concrete actions.
boolean	isDoGenerate()
boolean	isDoGenerateBundle()
boolean	isFailIfWarning()
boolean	isForce()
boolean	isUseMissingFile()
protected abstract SortedMap<String,org.apache.maven.project.MavenProject>	loadDependencies() Loads the dependencies of the project (as MavenProject, indexed by their gav.
void	setExcludedLicenses(String excludedLicenses) Fill the excludedLicenses parameter from a simple string to split.
void	setIncludedLicenses(String includedLicenses) Fill the includedLicenses parameter from a simple string to split.
protected void	writeThirdPartyFile()

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

acceptPackaging, addResourceDir, afterExecute, checkEncoding, checkPackaging, checkSkip, doAction, execute, getBuildTimestamp, getEncoding, getProject, getSession, hasClassPath, isSkip, 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

Constructor Detail

AbstractAddThirdPartyMojo

public AbstractAddThirdPartyMojo()

Method Detail

loadDependencies

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

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

Returns:

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

createUnsafeMapping

protected abstract 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.

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

init

protected void init()
             throws Exception

Method to initialize the mojo before doing any concrete actions.

Note: The method is invoked before the AbstractLicenseMojo.doAction() method.

Specified by:

init in class AbstractLicenseMojo

Throws:

Exception - if any

getOutputDirectory

public File getOutputDirectory()

isFailIfWarning

public boolean isFailIfWarning()

getProjectDependencies

public SortedMap<String,org.apache.maven.project.MavenProject> getProjectDependencies()

getUnsafeDependencies

public SortedSet<org.apache.maven.project.MavenProject> getUnsafeDependencies()

getLicenseMap

public LicenseMap getLicenseMap()

isUseMissingFile

public boolean isUseMissingFile()

getMissingFile

public File getMissingFile()

getUnsafeMappings

public SortedProperties getUnsafeMappings()

isForce

public boolean isForce()

isDoGenerate

public boolean isDoGenerate()

isDoGenerateBundle

public boolean isDoGenerateBundle()

getExcludedLicenses

public List<String> getExcludedLicenses()

Returns:

list of license to exclude.

getIncludedLicenses

public List<String> getIncludedLicenses()

Returns:

list of license to include.

setIncludedLicenses

public void setIncludedLicenses(String includedLicenses)

Fill the includedLicenses parameter from a simple string to split.

Parameters:

includedLicenses - license to excludes separated by a |.

setExcludedLicenses

public void setExcludedLicenses(String excludedLicenses)

Fill the excludedLicenses parameter from a simple string to split.

Parameters:

excludedLicenses - license to excludes separated by a |.

getHelper

protected ThirdPartyHelper getHelper()

checkUnsafeDependencies

protected boolean checkUnsafeDependencies()

checkForbiddenLicenses

protected boolean checkForbiddenLicenses()

writeThirdPartyFile

protected void writeThirdPartyFile()
                            throws IOException

Throws:

IOException