com.sourceclear.plugins

Class ScanMavenMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.sourceclear.plugins.ScanMavenMojo

All Implemented Interfaces:

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

@Mojo(name="scan",
      requiresDependencyCollection=TEST,
      instantiationStrategy=SINGLETON)
public class ScanMavenMojo
extends org.apache.maven.plugin.AbstractMojo

The scan goal runs the SRC:CLR scan on the project described by the Maven pom.xml and all submodules.

Upon completion, a list of found vulnerable components will be reported on the console and, if upload is true, will be uploaded to the SRC:CLR platform.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiToken The apiToken property is used to provide your personal token to the SRC:CLR platform for authentication.
protected URI	apiURL The URL you are using for the SRC:CLR api.
org.apache.maven.settings.Settings	settings The settings, from some settings.xml file.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ScanMavenMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() The top-level plugin entry point.
protected File	getPathToTop()

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

settings

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

The settings, from some settings.xml file. We use this to grab proxy information.

apiURL

@Parameter(property="apiURL")
protected URI apiURL

The URL you are using for the SRC:CLR api.

You shouldn't need to use this unless directed to by SRC:CLR support.

apiToken

@Parameter(property="apiToken")
protected String apiToken

The apiToken property is used to provide your personal token to the SRC:CLR platform for authentication.

The scan will not finish successfully if this is not provided or if it is incorrect.

Constructor Detail

ScanMavenMojo

public ScanMavenMojo()

Method Detail

getPathToTop

protected File getPathToTop()

execute

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

The top-level plugin entry point.

Throws:

org.apache.maven.plugin.MojoExecutionException - If an unexpected failure occurs

org.apache.maven.plugin.MojoFailureException - On user error or the discovery of a vulnerability of confidence level at or above the failureThreshold