Package org.jenkinsci.plugins.DependencyCheck

Class DependencyCheckToolBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.DependencyCheck.DependencyCheckToolBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, Serializable, SimpleBuildStep

public class DependencyCheckToolBuilder
extends Builder
implements SimpleBuildStep, Serializable

Performs an analysis using the specified Dependency-Check CLI tool installation.

Since:

5.0.0

Author:

Steve Springett (steve.springett@owasp.org)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DependencyCheckToolBuilder.DependencyCheckToolBuilderDescriptor

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 inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
DependencyCheckToolBuilder(String odcInstallation)

Method Summary

Modifier and Type	Method	Description
protected ArgumentListBuilder	buildArgumentList(String odcScript, Run<?,?> build, FilePath workspace, EnvVars env, TaskListener listener)
String	getAdditionalArguments()
String	getNvdCredentialsId()
String	getOdcInstallation()
boolean	isDebug()
boolean	isSkipOnScmChange()
boolean	isSkipOnUpstreamChange()
boolean	isStopBuild()
void	perform(Run<?,?> build, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener)	This method is called whenever the build step is executed.
void	setAdditionalArguments(String additionalArguments)
void	setDebug(boolean debug)
void	setNvdCredentialsId(String nvdCredentialsId)
void	setSkipOnScmChange(boolean skipOnScmChange)
void	setSkipOnUpstreamChange(boolean skipOnUpstreamChange)
void	setStopBuild(boolean stopBuild)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, 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, getRequiredMonitorService, perform, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

DependencyCheckToolBuilder

@DataBoundConstructor
public DependencyCheckToolBuilder(String odcInstallation)

Method Details

getOdcInstallation

public String getOdcInstallation()

getAdditionalArguments

public String getAdditionalArguments()

setAdditionalArguments

@DataBoundSetter
public void setAdditionalArguments(String additionalArguments)

isSkipOnScmChange

public boolean isSkipOnScmChange()

setSkipOnScmChange

@DataBoundSetter
public void setSkipOnScmChange(boolean skipOnScmChange)

isSkipOnUpstreamChange

public boolean isSkipOnUpstreamChange()

setSkipOnUpstreamChange

@DataBoundSetter
public void setSkipOnUpstreamChange(boolean skipOnUpstreamChange)

setStopBuild

@DataBoundSetter
public void setStopBuild(boolean stopBuild)

isStopBuild

public boolean isStopBuild()

perform

public void perform(@NonNull
 Run<?,?> build,
 @NonNull
 FilePath workspace,
 @NonNull
 EnvVars env,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
             throws InterruptedException,
IOException

This method is called whenever the build step is executed.

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException

buildArgumentList

@NonNull
protected ArgumentListBuilder buildArgumentList(@NonNull
 String odcScript,
 @NonNull
 Run<?,?> build,
 @NonNull
 FilePath workspace,
 @NonNull
 EnvVars env,
 @NonNull
 TaskListener listener)
                                         throws AbortException

Throws:

AbortException

getNvdCredentialsId

public String getNvdCredentialsId()

setNvdCredentialsId

@DataBoundSetter
public void setNvdCredentialsId(String nvdCredentialsId)

isDebug

public boolean isDebug()

setDebug

@DataBoundSetter
public void setDebug(boolean debug)