Package com.veracode.jenkins.plugin

Class VeracodePipelineRecorder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

com.veracode.jenkins.plugin.VeracodePipelineRecorder

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class VeracodePipelineRecorder
extends Recorder
implements SimpleBuildStep

The VeracodePipelineRecorder class handles processing for "veracode" Pipeline script. The UI interface of Snippet Generator for "veracode: Upload and Scan with Veracode Pipeline" is defined in associated config.jelly.

This class extends the Recorder class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VeracodePipelineRecorder.PipelineDescriptorImpl

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

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields

Modifier and Type	Field	Description
String	applicationName
boolean	canFailJob
boolean	copyRemoteFiles
boolean	createProfile
boolean	createSandbox
String	criticality
boolean	debug
String	deleteIncompleteScanLevel
String	fileNamePattern
String	pHost
String	pPassword
String	pPort
String	pUser
String	replacementPattern
String	sandboxName
String	scanExcludesPattern
String	scanIncludesPattern
String	scanName
String	teams
Integer	timeout
boolean	timeoutFailsJob
boolean	unstableBuild
String	uploadExcludesPattern
String	uploadIncludesPattern
boolean	useProxy
String	vid
String	vkey
boolean	waitForScan

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor

Description

VeracodePipelineRecorder(String applicationName, String criticality, String sandboxName, String scanName, boolean waitForScan, int timeout, String deleteIncompleteScanLevel, boolean createProfile, String teams, boolean createSandbox, boolean timeoutFailsJob, boolean canFailJob, boolean unstableBuild, boolean debug, String uploadIncludesPattern, String uploadExcludesPattern, String scanIncludesPattern, String scanExcludesPattern, String fileNamePattern, String replacementPattern, boolean copyRemoteFiles, boolean useProxy, String pHost, String pPort, String pUser, String pPassword, String vid, String vkey)

Constructor for VeracodePipelineRecorder.

Method Summary

Modifier and Type	Method	Description
Boolean	getDeleteIncompleteScan()
VeracodePipelineRecorder.PipelineDescriptorImpl	getDescriptor()	Returns the VeracodePipelineRecorder.PipelineDescriptorImpl object associated with this instance.
BuildStepMonitor	getRequiredMonitorService()	Returns an object that represents the scope of the synchronization monitor expected by the plugin.
void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener)	Called by Jenkins after a build for a job specified to use the plugin is performed.
void	setDeleteIncompleteScan(Boolean deleteIncompleteScan)

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Field Detail

applicationName

@DataBoundSetter
public final String applicationName

criticality

@DataBoundSetter
public final String criticality

sandboxName

@DataBoundSetter
public final String sandboxName

scanName

@DataBoundSetter
public final String scanName

waitForScan

@DataBoundSetter
public final boolean waitForScan

timeout

@DataBoundSetter
public final Integer timeout

deleteIncompleteScanLevel

@DataBoundSetter
public String deleteIncompleteScanLevel

createProfile

@DataBoundSetter
public final boolean createProfile

teams

@DataBoundSetter
public final String teams

createSandbox

@DataBoundSetter
public final boolean createSandbox

timeoutFailsJob

@DataBoundSetter
public final boolean timeoutFailsJob

canFailJob

@DataBoundSetter
public final boolean canFailJob

unstableBuild

@DataBoundSetter
public final boolean unstableBuild

debug

@DataBoundSetter
public final boolean debug

copyRemoteFiles

@DataBoundSetter
public final boolean copyRemoteFiles

uploadIncludesPattern

@DataBoundSetter
public final String uploadIncludesPattern

uploadExcludesPattern

@DataBoundSetter
public final String uploadExcludesPattern

scanIncludesPattern

@DataBoundSetter
public final String scanIncludesPattern

scanExcludesPattern

@DataBoundSetter
public final String scanExcludesPattern

fileNamePattern

@DataBoundSetter
public final String fileNamePattern

replacementPattern

@DataBoundSetter
public final String replacementPattern

vid

@DataBoundSetter
public final String vid

vkey

@DataBoundSetter
public final String vkey

useProxy

@DataBoundSetter
public final boolean useProxy

pHost

@DataBoundSetter
public final String pHost

pPort

@DataBoundSetter
public final String pPort

pUser

@DataBoundSetter
public final String pUser

pPassword

@DataBoundSetter
public final String pPassword

Constructor Detail

VeracodePipelineRecorder

@DataBoundConstructor
public VeracodePipelineRecorder(String applicationName,
                                String criticality,
                                String sandboxName,
                                String scanName,
                                boolean waitForScan,
                                int timeout,
                                String deleteIncompleteScanLevel,
                                boolean createProfile,
                                String teams,
                                boolean createSandbox,
                                boolean timeoutFailsJob,
                                boolean canFailJob,
                                boolean unstableBuild,
                                boolean debug,
                                String uploadIncludesPattern,
                                String uploadExcludesPattern,
                                String scanIncludesPattern,
                                String scanExcludesPattern,
                                String fileNamePattern,
                                String replacementPattern,
                                boolean copyRemoteFiles,
                                boolean useProxy,
                                String pHost,
                                String pPort,
                                String pUser,
                                String pPassword,
                                String vid,
                                String vkey)

Constructor for VeracodePipelineRecorder.

Parameters:

applicationName - a String object.

criticality - a String object.

sandboxName - a String object.

scanName - a String object.

waitForScan - a boolean.

timeout - a int.

deleteIncompleteScanLevel - a String object.

createProfile - a boolean.

teams - a String object.

createSandbox - a boolean.

timeoutFailsJob - a boolean.

canFailJob - a boolean.

unstableBuild - a boolean.

debug - a boolean.

uploadIncludesPattern - a String object.

uploadExcludesPattern - a String object.

scanIncludesPattern - a String object.

scanExcludesPattern - a String object.

fileNamePattern - a String object.

replacementPattern - a String object.

copyRemoteFiles - a boolean.

useProxy - a boolean.

pHost - a String object.

pPort - a String object.

pUser - a String object.

pPassword - a String object.

vid - a String object.

vkey - a String object.

Method Detail

getDeleteIncompleteScan

public Boolean getDeleteIncompleteScan()

setDeleteIncompleteScan

@DataBoundSetter
public void setDeleteIncompleteScan(Boolean deleteIncompleteScan)

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

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

Specified by:

getRequiredMonitorService in interface BuildStep

perform

public void perform(Run<?,?> run,
                    FilePath workspace,
                    Launcher launcher,
                    TaskListener listener)
             throws InterruptedException,
                    IOException

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

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException

getDescriptor

public VeracodePipelineRecorder.PipelineDescriptorImpl getDescriptor()

Returns the VeracodePipelineRecorder.PipelineDescriptorImpl object associated with this instance.

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Recorder