org.jenkinsci.plugins.DependencyCheck

Class DependencyCheckPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

hudson.plugins.analysis.core.HealthAwareRecorder

hudson.plugins.analysis.core.HealthAwarePublisher

org.jenkinsci.plugins.DependencyCheck.DependencyCheckPublisher

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.matrix.MatrixAggregatable, hudson.model.Describable<hudson.tasks.Publisher>, hudson.plugins.analysis.core.HealthDescriptor, hudson.tasks.BuildStep, Serializable

public class DependencyCheckPublisher
extends hudson.plugins.analysis.core.HealthAwarePublisher

Publishes the results of the Dependency-Check analysis (freestyle project type).

Author:

Steve Springett (steve.springett@owasp.org), based on PmdCheckPublisher by Ulli Hafner

See Also:

Serialized Form

Nested Class Summary

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description

DependencyCheckPublisher(String healthy, String unHealthy, String thresholdLimit, String defaultEncoding, boolean useDeltaValues, String unstableTotalAll, String unstableTotalHigh, String unstableTotalNormal, String unstableTotalLow, String unstableNewAll, String unstableNewHigh, String unstableNewNormal, String unstableNewLow, String failedTotalAll, String failedTotalHigh, String failedTotalNormal, String failedTotalLow, String failedNewAll, String failedNewHigh, String failedNewNormal, String failedNewLow, boolean canRunOnFailed, boolean useStableBuildAsReference, boolean shouldDetectModules, boolean canComputeNew, String pattern) Creates a new instance of DependencyCheckPublisher.

Method Summary

Methods

Modifier and Type	Method and Description
hudson.matrix.MatrixAggregator	createAggregator(hudson.matrix.MatrixBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)
DependencyCheckDescriptor	getDescriptor()
String	getPattern() Returns the Ant file-set pattern of files to work with.
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
hudson.plugins.analysis.core.BuildResult	perform(hudson.model.AbstractBuild<?,?> build, hudson.plugins.analysis.util.PluginLogger logger)

Methods inherited from class hudson.plugins.analysis.core.HealthAwarePublisher

perform, updateBuildResult

Methods inherited from class hudson.plugins.analysis.core.HealthAwareRecorder

canComputeNew, canContinue, canResolveRelativePaths, copyFilesWithAnnotationsToBuildFolder, getCanComputeNew, getCanResolveRelativePaths, getCanRunOnFailed, getDefaultEncoding, getHealthy, getMinimumPriority, getRequiredMonitorService, getShouldDetectModules, getThresholdLimit, getThresholds, getUnHealthy, getUseDeltaValues, getUseStableBuildAsReference, isAntBuild, isMavenBuild, isThresholdEnabled, perform, readResolve, shouldDetectModules, useOnlyStableBuildsAsReference

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectActions, 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

getProjectActions, prebuild

Constructor Detail

DependencyCheckPublisher

@DataBoundConstructor
public DependencyCheckPublisher(String healthy,
                                             String unHealthy,
                                             String thresholdLimit,
                                             String defaultEncoding,
                                             boolean useDeltaValues,
                                             String unstableTotalAll,
                                             String unstableTotalHigh,
                                             String unstableTotalNormal,
                                             String unstableTotalLow,
                                             String unstableNewAll,
                                             String unstableNewHigh,
                                             String unstableNewNormal,
                                             String unstableNewLow,
                                             String failedTotalAll,
                                             String failedTotalHigh,
                                             String failedTotalNormal,
                                             String failedTotalLow,
                                             String failedNewAll,
                                             String failedNewHigh,
                                             String failedNewNormal,
                                             String failedNewLow,
                                             boolean canRunOnFailed,
                                             boolean useStableBuildAsReference,
                                             boolean shouldDetectModules,
                                             boolean canComputeNew,
                                             String pattern)

Creates a new instance of DependencyCheckPublisher.

Parameters:

healthy - Report health as 100% when the number of warnings is less than this value

unHealthy - Report health as 0% when the number of warnings is greater than this value

thresholdLimit - determines which warning priorities should be considered when evaluating the build stability and health

defaultEncoding - the default encoding to be used when reading and parsing files

useDeltaValues - determines whether the absolute annotations delta or the actual annotations set difference should be used to evaluate the build stability

unstableTotalAll - annotation threshold

unstableTotalHigh - annotation threshold

unstableTotalNormal - annotation threshold

unstableTotalLow - annotation threshold

unstableNewAll - annotation threshold

unstableNewHigh - annotation threshold

unstableNewNormal - annotation threshold

unstableNewLow - annotation threshold

failedTotalAll - annotation threshold

failedTotalHigh - annotation threshold

failedTotalNormal - annotation threshold

failedTotalLow - annotation threshold

failedNewAll - annotation threshold

failedNewHigh - annotation threshold

failedNewNormal - annotation threshold

failedNewLow - annotation threshold

canRunOnFailed - determines whether the plug-in can run for failed builds, too

useStableBuildAsReference - determines whether only stable builds should be used as reference builds or not

canComputeNew - determines whether new warnings should be computed (with respect to baseline)

shouldDetectModules - determines whether module names should be derived from Maven POM or Ant build files

pattern - Ant file-set pattern to scan for Dependency-Check report files

Method Detail

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

getProjectAction

public hudson.model.Action getProjectAction(hudson.model.AbstractProject<?,?> project)

Specified by:

getProjectAction in interface hudson.tasks.BuildStep

Overrides:

getProjectAction in class hudson.tasks.BuildStepCompatibilityLayer

perform

public hudson.plugins.analysis.core.BuildResult perform(hudson.model.AbstractBuild<?,?> build,
                                               hudson.plugins.analysis.util.PluginLogger logger)
                                                 throws InterruptedException,
                                                        IOException

Specified by:

perform in class hudson.plugins.analysis.core.HealthAwarePublisher

Throws:

InterruptedException

IOException

getDescriptor

public DependencyCheckDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.plugins.analysis.core.HealthAwareRecorder

createAggregator

public hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild build,
                                              hudson.Launcher launcher,
                                              hudson.model.BuildListener listener)