org.jenkinsci.plugins.DependencyCheck
Class DependencyCheckUpdateOnlyBuilder

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Builder
          org.jenkinsci.plugins.DependencyCheck.AbstractDependencyCheckBuilder
              org.jenkinsci.plugins.DependencyCheck.DependencyCheckUpdateOnlyBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep, Serializable

public class DependencyCheckUpdateOnlyBuilder
extends AbstractDependencyCheckBuilder
implements Serializable

The DependencyCheckUpdateOnlyBuilder builder class provides the ability to invoke a DependencyCheck NVD update only as a Jenkins build step. This class takes the configuration from the UI, creates options from them and passes them to the DependencyCheckExecutor for the actual execution of the DependencyCheck Engine.

Author:

Steve Springett (steve.springett@owasp.org)

See Also:

Serialized Form

Nested Class Summary

static class

DependencyCheckUpdateOnlyBuilder.DescriptorImpl Descriptor for DependencyCheckUpdateOnlyBuilder.

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 class org.jenkinsci.plugins.DependencyCheck.AbstractDependencyCheckBuilder

OUT_TAG, skipOnScmChange, skipOnUpstreamChange

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

DependencyCheckUpdateOnlyBuilder(String datadir, Boolean isVerboseLoggingEnabled, Boolean includeHtmlReports)

Method Summary

String	getDatadir() Retrieves the data directory that DependencyCheck will use.
DependencyCheckUpdateOnlyBuilder.DescriptorImpl	getDescriptor() A Descriptor Implementation.
boolean	isVerboseLoggingEnabled() Retrieves whether verbose logging is enabled or not.
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) This method is called whenever the DependencyCheck build step is executed.

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

configureDataDirectory, configureDataMirroring, configureProxySettings, isMaven, optionsBuilder, setOptions, substituteVariable, toCommaSeparatedString

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyCheckUpdateOnlyBuilder

@DataBoundConstructor
public DependencyCheckUpdateOnlyBuilder(String datadir,
                                                             Boolean isVerboseLoggingEnabled,
                                                             Boolean includeHtmlReports)

Method Detail

getDatadir

public String getDatadir()

Retrieves the data directory that DependencyCheck will use. This is a per-build config item. This method must match the value in config.jelly.

isVerboseLoggingEnabled

public boolean isVerboseLoggingEnabled()

Retrieves whether verbose logging is enabled or not. This is a per-build config item. This method must match the value in config.jelly.

perform

public boolean perform(hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException

This method is called whenever the DependencyCheck build step is executed.

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class AbstractDependencyCheckBuilder

Parameters:

build - A Build object

launcher - A Launcher object

listener - A BuildListener object

Returns:

A true or false value indicating if the build was successful or if it failed

Throws:

InterruptedException

IOException

getDescriptor

public DependencyCheckUpdateOnlyBuilder.DescriptorImpl getDescriptor()

A Descriptor Implementation.

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Builder