Package org.codehaus.mojo.license

Class AbstractLicensesXmlMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.license.AbstractLicensesXmlMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDownloadLicensesMojo, LicensesXmlInsertVersionsMojo

public abstract class AbstractLicensesXmlMojo
extends org.apache.maven.plugin.AbstractMojo

A common parent for LicensesXmlInsertVersionsMojo and AbstractDownloadLicensesMojo.

Since:

1.19

Author:

Peter Palaga

Field Summary

Fields

Modifier and Type	Field	Description
protected final LicensedArtifactResolver	licensedArtifactResolver	Licensed artifact resolver.
protected File	licensesOutputFile	The output file containing a mapping between each dependency and its license information.
protected Eol	licensesOutputFileEol	An end of line constant name denoting the EOL string to use when redering the licenses.xml file.
protected org.apache.maven.project.MavenProject	project	The Maven Project Object
protected List<org.apache.maven.artifact.repository.ArtifactRepository>	remoteRepositories	List of Remote Repositories used by the resolver

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLicensesXmlMojo(LicensedArtifactResolver licensedArtifactResolver)

Method Summary

Modifier and Type	Method	Description
protected Path[]	getAutodetectEolFiles()
String	getEncoding()
protected void	writeLicenseSummary(List<ProjectLicenseInfo> deps, File licensesOutputFile, boolean writeVersions)

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.apache.maven.plugin.Mojo

execute

Field Details

licensesOutputFile

@Parameter(property="licensesOutputFile",
           defaultValue="${project.build.directory}/generated-resources/licenses.xml")
protected File licensesOutputFile

The output file containing a mapping between each dependency and its license information.

Since:

1.0

licensesOutputFileEol

@Parameter(property="licensesOutputFileEol",
           defaultValue="AUTODETECT")
protected Eol licensesOutputFileEol

An end of line constant name denoting the EOL string to use when redering the licenses.xml file. Possible values are LF, CRLF, AUTODETECT and PLATFORM.

When the value AUTODETECT is used, the mojo will use whatever EOL value is used in the first existing of the following files:

invalid reference

#licensesConfigFile

, ${basedir}/pom.xml.

The value PLATFORM is deprecated but still kept for backwards compatibility reasons.

Since:

1.17

remoteRepositories

@Parameter(defaultValue="${project.remoteArtifactRepositories}",
           readonly=true)
protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories

List of Remote Repositories used by the resolver

Since:

1.0

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

The Maven Project Object

Since:

1.0

licensedArtifactResolver

protected final LicensedArtifactResolver licensedArtifactResolver

Licensed artifact resolver.

Since:

1.0

Constructor Details

AbstractLicensesXmlMojo

protected AbstractLicensesXmlMojo(LicensedArtifactResolver licensedArtifactResolver)

Method Details

getEncoding

public String getEncoding()

getAutodetectEolFiles

protected Path[] getAutodetectEolFiles()

writeLicenseSummary

protected void writeLicenseSummary(List<ProjectLicenseInfo> deps,
 File licensesOutputFile,
 boolean writeVersions)
                            throws ParserConfigurationException,
TransformerException,
IOException

Throws:

ParserConfigurationException

TransformerException

IOException