Package com.vrondakis.zap.workflow

Class ArchiveZapStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

com.vrondakis.zap.workflow.ArchiveZapStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable

public class ArchiveZapStep
extends org.jenkinsci.plugins.workflow.steps.Step
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArchiveZapStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ArchiveZapStep(Integer failAllAlerts, Integer failHighAlerts, Integer failMediumAlerts, Integer failLowAlerts, String falsePositivesFilePath, boolean keepAlive)	Analyse the zap attack and generate the zap report, then stop the zap instance.

Method Summary

Modifier and Type	Method	Description
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveZapStep

@DataBoundConstructor
public ArchiveZapStep(Integer failAllAlerts,
                      Integer failHighAlerts,
                      Integer failMediumAlerts,
                      Integer failLowAlerts,
                      String falsePositivesFilePath,
                      boolean keepAlive)

Analyse the zap attack and generate the zap report, then stop the zap instance.

Parameters:

failAllAlerts - Fail the run if there is x or more of any type of alert - default 0 (disabled)

failHighAlerts - Fail the run when there is x or more of HIGH risk alerts - default 1

failMediumAlerts - Fail the run when there is x or more of MEDIUM risk alerts - default 0 (disabled)

failLowAlerts - Fail the run when there is more x or more LOW risk alerts - default 0 (disabled)

falsePositivesFilePath - File name and path (relative to workspace) to the falsePositives config file - default "zapfalsePositives.json"

keepAlive - If true, the zap application will not be sent the shutdown command.

Method Detail

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws IOException,
                                                                InterruptedException

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

IOException

InterruptedException