Package com.vrondakis.zap.workflow

Class RunZapCrawlerStep

java.lang.Object

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

org.jenkinsci.plugins.workflow.steps.Step

com.vrondakis.zap.workflow.RunZapCrawlerStep

All Implemented Interfaces:

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

public class RunZapCrawlerStep
extends org.jenkinsci.plugins.workflow.steps.Step

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RunZapCrawlerStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
RunZapCrawlerStep(String host, int maxChildren, String contextName, int contextId, boolean subtreeOnly, boolean recurse, int userId)	For zapCrawler() function in Jenkinsfile

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

RunZapCrawlerStep

@DataBoundConstructor
public RunZapCrawlerStep(@CheckForNull
                         String host,
                         int maxChildren,
                         String contextName,
                         int contextId,
                         boolean subtreeOnly,
                         boolean recurse,
                         int userId)

For zapCrawler() function in Jenkinsfile

Parameters:

host - The host url to scan.

maxChildren - Set a limit to the number of children scanned (optional).

contextName - The ZAP context name to run the attack with when running without a user (optional).

contextId - The ZAP context ID to run the attack with when running with a user (optional).

subtreeOnly - Restricts the spider to the host url subtree (optional).

recurse - Prevents the spider from seeding recursively (optional).

userId - The ZAP user ID to run the crawl with, loaded from the context (optional).

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