Package com.cloudbees.maven.license

Class ProcessMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.cloudbees.maven.license.ProcessMojo

All Implemented Interfaces:

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

@Mojo(name="process",
      requiresDependencyResolution=RUNTIME)
public class ProcessMojo
extends org.apache.maven.plugin.AbstractMojo

Process license information.

Field Summary

Fields

Modifier and Type	Field	Description
org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory
boolean	attach	If true, attach the generated XML/HTML as artifacts (to be installed/deployed to Maven repositories.)
boolean	disableCheck	Forbidden switch to disable and bypass all the checks.
File	generateLicenseHtml	If true, generate "licenses.html" as the visualization of license.xml
File	generateLicenseXml	If true, generate "licenses.xml" that captures all the dependencies and its licenses.
String	inlineScript	Specifies completion/generation/filtering script inline.
org.apache.maven.project.MavenProject	project	The maven project.
org.apache.maven.project.ProjectBuilder	projectBuilder
org.apache.maven.project.MavenProjectHelper	projectHelper
boolean	requireCompleteLicenseInfo	If true, require all the dependencies to have license information after running completion scripts, or fail the build.
File	script	Specifies completion/generation/filtering scripts.
org.apache.maven.execution.MavenSession	session

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

ROLE

Constructor Summary

Constructors

Constructor	Description
ProcessMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

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

projectHelper

@Component
public org.apache.maven.project.MavenProjectHelper projectHelper

project

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

The maven project.

session

@Parameter(defaultValue="${session}",
           required=true,
           readonly=true)
public org.apache.maven.execution.MavenSession session

projectBuilder

@Component
public org.apache.maven.project.ProjectBuilder projectBuilder

artifactFactory

@Component
public org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

script

@Parameter(defaultValue="${license.script}")
public File script

Specifies completion/generation/filtering scripts.

This can be either a file or a directory. If it's a directory all the files in it are assumed to be completer scripts.

inlineScript

@Parameter
public String inlineScript

Specifies completion/generation/filtering script inline.

requireCompleteLicenseInfo

@Parameter
public boolean requireCompleteLicenseInfo

If true, require all the dependencies to have license information after running completion scripts, or fail the build.

generateLicenseXml

@Parameter(defaultValue="${license.generateLicenseXml}")
public File generateLicenseXml

If true, generate "licenses.xml" that captures all the dependencies and its licenses.

generateLicenseHtml

@Parameter(defaultValue="${license.generateLicenseHtml}")
public File generateLicenseHtml

If true, generate "licenses.html" as the visualization of license.xml

disableCheck

@Parameter(defaultValue="${license.disableCheck}")
public boolean disableCheck

Forbidden switch to disable and bypass all the checks.

attach

@Parameter(defaultValue="${license.attach}")
public boolean attach

If true, attach the generated XML/HTML as artifacts (to be installed/deployed to Maven repositories.)

Constructor Detail

ProcessMojo

public ProcessMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException