org.jenkinsci.plugins.zap

Class ZAPBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.zap.ZAPBuilder

All Implemented Interfaces:

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

public class ZAPBuilder
extends hudson.tasks.Builder

The main class of the plugin. This class adds a build step in a Jenkins job that allows you to launch the ZAP security tool and generate reports based on the alerts.

Author:

Goran Sarenkapa, Mostafa AbdelMoez, Tanguy de Lignières, Abdellah Azougarh, Thilina Madhusanka, Johann Ollivier-Lapeyre, Ludovic Roucoux

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZAPBuilder.ZAPBuilderDescriptorImpl

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

Modifier and Type	Field and Description
static ZAPBuilder.ZAPBuilderDescriptorImpl	DESCRIPTOR

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
ZAPBuilder(boolean startZAPFirst, String zapHost, String zapPort, ZAPDriver zaproxy) The @DataBoundConstructor is a constructor and it's parameter names must match the fields in associated config file "com/github/jenkinsci/zaproxyplugin/ZAPBuilder/config.jelly" and additional can set the parameter values for the global configurations "com/github/jenkinsci/zaproxyplugin/ZAPBuilder/global.jelly".

Method Summary

Modifier and Type	Method and Description
static String	applyMacro(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener, String macro) Replace macro with environment variable if it exists.
ZAPBuilder.ZAPBuilderDescriptorImpl	getDescriptor()
boolean	getStartZAPFirst()
String	getZapHost()
String	getZapPort()
ZAPDriver	getZaproxy()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Method called when the build is launching
boolean	prebuild(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener) Method launched before the build.

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR

@Extension
public static final ZAPBuilder.ZAPBuilderDescriptorImpl DESCRIPTOR

Constructor Detail

ZAPBuilder

@DataBoundConstructor
public ZAPBuilder(boolean startZAPFirst,
                                         String zapHost,
                                         String zapPort,
                                         ZAPDriver zaproxy)

The @DataBoundConstructor is a constructor and it's parameter names must match the fields in associated config file "com/github/jenkinsci/zaproxyplugin/ZAPBuilder/config.jelly" and additional can set the parameter values for the global configurations "com/github/jenkinsci/zaproxyplugin/ZAPBuilder/global.jelly".

Parameters:

startZAPFirst - of type boolean: start zap as a pre-build step or not.

zapHost - of type: String: the zap host.

zapPort - of type String: host configured when ZAP is used as proxy.

zaproxy - of type ZAPDriver: port configured when ZAP is used as proxy.

Method Detail

getStartZAPFirst

public boolean getStartZAPFirst()

getZaproxy

public ZAPDriver getZaproxy()

getZapHost

public String getZapHost()

getZapPort

public String getZapPort()

getDescriptor

public ZAPBuilder.ZAPBuilderDescriptorImpl getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Builder

prebuild

public boolean prebuild(hudson.model.AbstractBuild<?,?> build,
                        hudson.model.BuildListener listener)

Method launched before the build.

Specified by:

prebuild in interface hudson.tasks.BuildStep

Overrides:

prebuild in class hudson.tasks.BuildStepCompatibilityLayer

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)

Method called when the build is launching

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

applyMacro

public static String applyMacro(hudson.model.AbstractBuild<?,?> build,
                                hudson.model.BuildListener listener,
                                String macro)
                         throws InterruptedException

Replace macro with environment variable if it exists.

Parameters:

build -

listener -

macro -

Returns:

Throws:

InterruptedException