Package org.jenkinsci.plugins.DependencyCheck

Class DependencyCheckPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

org.jenkinsci.plugins.DependencyCheck.AbstractThresholdPublisher

org.jenkinsci.plugins.DependencyCheck.DependencyCheckPublisher

All Implemented Interfaces:

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

public class DependencyCheckPublisher
extends AbstractThresholdPublisher
implements SimpleBuildStep

Ported from the Dependency-Track Jenkins plugin. Not related to the original DependencyCheckPublisher included with v1.0.0 - v4.0.2.

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 final class	DependencyCheckPublisher.DescriptorImpl

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

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
DependencyCheckPublisher()

Method Summary

Modifier and Type	Method	Description
String	getPattern()	Returns the Ant file-set pattern of files to work with.
BuildStepMonitor	getRequiredMonitorService()
boolean	isSkipNoReportFiles()
boolean	isStopBuild()
void	perform(Run<?,?> build, FilePath filePath, EnvVars env, Launcher launcher, TaskListener listener)	This method is called whenever the build step is executed.
Result	process(Run<?,?> build, FilePath filePath, Launcher launcher, TaskListener listener)
void	setPattern(String pattern)	Sets the Ant file-set pattern of files to work with.
void	setSkipNoReportFiles(boolean skipNoReportFiles)
void	setStopBuild(boolean stopBuild)

Methods inherited from class org.jenkinsci.plugins.DependencyCheck.AbstractThresholdPublisher

getFailedNewCritical, getFailedNewHigh, getFailedNewLow, getFailedNewMedium, getFailedTotalCritical, getFailedTotalHigh, getFailedTotalLow, getFailedTotalMedium, getNewThresholdAnalysisExploitable, getTotalThresholdAnalysisExploitable, getUnstableNewCritical, getUnstableNewHigh, getUnstableNewLow, getUnstableNewMedium, getUnstableTotalCritical, getUnstableTotalHigh, getUnstableTotalLow, getUnstableTotalMedium, setFailedNewCritical, setFailedNewHigh, setFailedNewLow, setFailedNewMedium, setFailedTotalCritical, setFailedTotalHigh, setFailedTotalLow, setFailedTotalMedium, setNewThresholdAnalysisExploitable, setTotalThresholdAnalysisExploitable, setUnstableNewCritical, setUnstableNewHigh, setUnstableNewLow, setUnstableNewMedium, setUnstableTotalCritical, setUnstableTotalHigh, setUnstableTotalLow, setUnstableTotalMedium

Methods inherited from class hudson.tasks.Recorder

getDescriptor

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

Constructor Details

DependencyCheckPublisher

@DataBoundConstructor
public DependencyCheckPublisher()

Method Details

getPattern

public String getPattern()

Returns the Ant file-set pattern of files to work with.

Returns:

Ant file-set pattern of files to work with

setPattern

@DataBoundSetter
public void setPattern(String pattern)

Sets the Ant file-set pattern of files to work with.

Parameters:

pattern - the pattern of files

setStopBuild

@DataBoundSetter
public void setStopBuild(boolean stopBuild)

isStopBuild

public boolean isStopBuild()

isSkipNoReportFiles

public boolean isSkipNoReportFiles()

setSkipNoReportFiles

@DataBoundSetter
public void setSkipNoReportFiles(boolean skipNoReportFiles)

perform

public void perform(@NonNull
 Run<?,?> build,
 @NonNull
 FilePath filePath,
 @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

Parameters:

build - A Run object

filePath - A FilePath object

launcher - A Launcher object

listener - A BuildListener object

Throws:

InterruptedException

IOException

process

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public Result process(@NonNull
 Run<?,?> build,
 @NonNull
 FilePath filePath,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
               throws InterruptedException,
IOException

Throws:

InterruptedException

IOException

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep