Package com.veracode.jenkins.plugin

Class VeracodeNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

com.veracode.jenkins.plugin.VeracodeNotifier

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep

public class VeracodeNotifier
extends Notifier

The VeracodeNotifier class contains the code that is executed after a job that is configured to use the Veracode plugin is built and provides getter methods for the form fields defined in config.jelly.

This class extends the Notifier class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VeracodeNotifier.VeracodeDescriptor	Contains the code that is executed after a user submits the "Configure System" form and provides getter methods for the form fields defined in global.jelly.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor

Description

VeracodeNotifier(String appname, boolean createprofile, String teams, String criticality, String sandboxname, boolean createsandbox, String version, String filenamepattern, String replacementpattern, String uploadincludespattern, String uploadexcludespattern, String scanincludespattern, String scanexcludespattern, boolean scanallnonfataltoplevelmodules, boolean includenewmodules, boolean waitForScan, String timeout, String deleteIncompleteScan, CredentialsBlock credentials)

Constructor for VeracodeNotifier.

Method Summary

Modifier and Type	Method	Description
String	getAppname()
boolean	getCreateprofile()
boolean	getCreatesandbox()
CredentialsBlock	getCredentials()
String	getCriticality()
String	getDeleteIncompleteScan()
VeracodeNotifier.VeracodeDescriptor	getDescriptor()	Returns the VeracodeDescriptor object associated with this instance.
String	getFilenamepattern()
boolean	getIncludenewmodules()
String	getReplacementpattern()
BuildStepMonitor	getRequiredMonitorService()	Returns an object that represents the scope of the synchronization monitor expected by the plugin.
String	getSandboxname()
boolean	getScanallnonfataltoplevelmodules()
String	getScanexcludespattern()
String	getScanincludespattern()
String	getTeams()
String	getTimeout()
String	getUploadexcludespattern()
String	getUploadincludespattern()
String	getVersion()
String	getVid()
String	getVkey()
boolean	getWaitForScan()
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)	Called by Jenkins after a build for a job specified to use the plugin is performed.
boolean	prebuild(AbstractBuild<?,?> build, BuildListener listener)	In this overridden method we are taking care of copying the wrapper to remote location and making the build ready for scan

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VeracodeNotifier

@DataBoundConstructor
public VeracodeNotifier(String appname,
                        boolean createprofile,
                        String teams,
                        String criticality,
                        String sandboxname,
                        boolean createsandbox,
                        String version,
                        String filenamepattern,
                        String replacementpattern,
                        String uploadincludespattern,
                        String uploadexcludespattern,
                        String scanincludespattern,
                        String scanexcludespattern,
                        boolean scanallnonfataltoplevelmodules,
                        boolean includenewmodules,
                        boolean waitForScan,
                        String timeout,
                        String deleteIncompleteScan,
                        CredentialsBlock credentials)

Constructor for VeracodeNotifier.

Called by Jenkins with data supplied in the "Job Configuration" page.

Parameters:

appname - a String object.

createprofile - a boolean.

teams - a String object.

criticality - a String object.

sandboxname - a String object.

createsandbox - a boolean.

version - a String object.

filenamepattern - a String object.

replacementpattern - a String object.

uploadincludespattern - a String object.

uploadexcludespattern - a String object.

scanincludespattern - a String object.

scanexcludespattern - a String object.

scanallnonfataltoplevelmodules - a boolean

includenewmodules - a boolean

waitForScan - a boolean.

timeout - a String object.

deleteIncompleteScan - a boolean.

credentials - a CredentialsBlock object.

Method Detail

getAppname

public String getAppname()

getCreateprofile

public boolean getCreateprofile()

getTeams

public String getTeams()

getCriticality

public String getCriticality()

getSandboxname

public String getSandboxname()

getCreatesandbox

public boolean getCreatesandbox()

getVersion

public String getVersion()

getUploadincludespattern

public String getUploadincludespattern()

getUploadexcludespattern

public String getUploadexcludespattern()

getScanincludespattern

public String getScanincludespattern()

getScanexcludespattern

public String getScanexcludespattern()

getScanallnonfataltoplevelmodules

public boolean getScanallnonfataltoplevelmodules()

getIncludenewmodules

public boolean getIncludenewmodules()

getFilenamepattern

public String getFilenamepattern()

getReplacementpattern

public String getReplacementpattern()

getCredentials

public CredentialsBlock getCredentials()

getWaitForScan

public boolean getWaitForScan()

getTimeout

public String getTimeout()

getDeleteIncompleteScan

public String getDeleteIncompleteScan()

getVid

public String getVid()

getVkey

public String getVkey()

getDescriptor

public VeracodeNotifier.VeracodeDescriptor getDescriptor()

Returns the VeracodeDescriptor object associated with this instance.

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Notifier

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Returns an object that represents the scope of the synchronization monitor expected by the plugin.

prebuild

public boolean prebuild(AbstractBuild<?,?> build,
                        BuildListener listener)

In this overridden method we are taking care of copying the wrapper to remote location and making the build ready for scan

Specified by:

prebuild in interface BuildStep

Overrides:

prebuild in class BuildStepCompatibilityLayer

perform

public boolean perform(AbstractBuild<?,?> build,
                       Launcher launcher,
                       BuildListener listener)
                throws IOException,
                       InterruptedException

Called by Jenkins after a build for a job specified to use the plugin is performed.

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

Throws:

IOException

InterruptedException