org.complykit.licensecheck.mojo
Class LicenseCheckMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.complykit.licensecheck.mojo.LicenseCheckMojo

All Implemented Interfaces:

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

@Mojo(name="check")
public class LicenseCheckMojo
extends org.apache.maven.plugin.AbstractMojo

This early version of the license check plug in simply checks to see whether there is a license declared for a given dependency. This is important because, technically, if no license is associated with a given dependency, that could mean that the owner of the dependency retains all rights associated with the library. Future versions of the license-check will go further.

Author:

michael rice

Field Summary

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

ROLE

Constructor Summary

LicenseCheckMojo()

Method Summary

boolean	checkArtifact(String dependencyCoordinates) This method actually runs the artifact's coordinates against a validation server.
void	execute() This is the primary entry point into the Maven plugin.

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

LicenseCheckMojo

public LicenseCheckMojo()

Method Detail

execute

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

This is the primary entry point into the Maven plugin.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

checkArtifact

public boolean checkArtifact(String dependencyCoordinates)

This method actually runs the artifact's coordinates against a validation server. Right now, all the logic is buried into this big function.

Parameters:

dependencyCoordinates -

Returns:

true if the artifact passes the checks.