io.solit.plugin.maven.deb.copyright

Class CopyrightMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.solit.plugin.maven.deb.dependencies.AbstractDependencyMojo<Copyright>

io.solit.plugin.maven.deb.copyright.CopyrightMojo

All Implemented Interfaces:

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

@Mojo(name="copyright",
      defaultPhase=PREPARE_PACKAGE)
public class CopyrightMojo
extends AbstractDependencyMojo<Copyright>

Create a machine readable copyright file. File is formatted to follow debian copyright specification. File will include information specified in a configuration or extracted from a pom file if no configuration present. Additionally, if dependencies are included into a package, copyright file will include their licences too.

Copyright info is build based on a copyrightPatterns parameter and gathered from a pom file if no copyrightPatterns specified.

• Copyright is constructed from a copyright symbol, inceptionYear (if present), current year and holders:
  1. project organisation, if present
  2. otherwise, project developers if present
  3. otherwise, project contributors if present
  4. otherwise user.name system property is used
• For project license mainLicence parameter is used if specified, otherwise first of project licenses is used. If no licenses present, project is marked as a public domain.

If dependencyCopyrights parameter is set to true, all dependencies filtered by traversalExclusions and packageExclusions are grouped by their copyright and licenses and included as a separate file. Copyright and license strings are constructed the same way as for this project

Since:

23.01.18

Author:

yaga

See Also:

copyright specification

Nested Class Summary

Nested classes/interfaces inherited from class io.solit.plugin.maven.deb.dependencies.AbstractDependencyMojo

AbstractDependencyMojo.DependencyArtifact

Field Summary

Fields inherited from class io.solit.plugin.maven.deb.dependencies.AbstractDependencyMojo

packageName, project, session, stageDir

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CopyrightMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected void	processDependency(AbstractDependencyMojo.DependencyArtifact node, Copyright copyright, File dependencyDir, boolean root)

Methods inherited from class io.solit.plugin.maven.deb.dependencies.AbstractDependencyMojo

getDependencyDirectory, traverseDependencies

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

CopyrightMojo

public CopyrightMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

processDependency

protected void processDependency(AbstractDependencyMojo.DependencyArtifact node,
                                 Copyright copyright,
                                 File dependencyDir,
                                 boolean root)

Specified by:

processDependency in class AbstractDependencyMojo<Copyright>