Package com.veracode.jenkins.plugin

Class DynamicAnalysisStartNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

com.veracode.jenkins.plugin.DynamicAnalysisStartNotifier

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep

public class DynamicAnalysisStartNotifier
extends Notifier

The DynamicAnalysisStartNotifier class handles processing for post build action "Resubmit Veracode Dynamic Analysis". The UI interface is defined in associated config.jelly.

User provides: - Dynamic Analysis name - max duration in hours for analysis scan - whether to fail Jenkins build if the analysis fails to run - whether to use global API credentials or define ID/Key specific to the job. This class extends the Notifier class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DynamicAnalysisStartNotifier.DynamicAnalysisStartDescriptor

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
DynamicAnalysisStartNotifier(String analysisName, int maximumDuration, boolean failBuildAsScanFailed, CredentialsBlock credentials)	Constructor for DynamicAnalysisStartNotifier.

Method Summary

Modifier and Type	Method	Description
String	getAnalysisName()
CredentialsBlock	getCredentials()
DynamicAnalysisStartNotifier.DynamicAnalysisStartDescriptor	getDescriptor()	Returns the DynamicAnalysisStartNotifier.DynamicAnalysisStartDescriptor object associated with this instance.
int	getMaximumDuration()
BuildStepMonitor	getRequiredMonitorService()	Returns an object that represents the scope of the synchronization monitor expected by the plugin.
String	getVid()
String	getVkey()
boolean	isFailBuildAsScanFailed()
boolean	isGlobalCredentialsEnabled()
boolean	perform(AbstractBuild build, Launcher launcher, BuildListener listener)	Called by Jenkins after a build for a job specified to use the plugin is performed.

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicAnalysisStartNotifier

@DataBoundConstructor
public DynamicAnalysisStartNotifier(String analysisName,
                                    int maximumDuration,
                                    boolean failBuildAsScanFailed,
                                    CredentialsBlock credentials)

Constructor for DynamicAnalysisStartNotifier.

Parameters:

analysisName - a String object.

maximumDuration - a int.

failBuildAsScanFailed - a boolean.

credentials - a CredentialsBlock object.

Method Detail

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

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

perform

public boolean perform(AbstractBuild build,
                       Launcher launcher,
                       BuildListener listener)

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

getDescriptor

public DynamicAnalysisStartNotifier.DynamicAnalysisStartDescriptor getDescriptor()

Returns the DynamicAnalysisStartNotifier.DynamicAnalysisStartDescriptor object associated with this instance.

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Notifier

getAnalysisName

public String getAnalysisName()

getMaximumDuration

public int getMaximumDuration()

isFailBuildAsScanFailed

public boolean isFailBuildAsScanFailed()

isGlobalCredentialsEnabled

public boolean isGlobalCredentialsEnabled()

getCredentials

public CredentialsBlock getCredentials()

getVid

public String getVid()

getVkey

public String getVkey()