fr.novia.zaproxyplugin

Class ZAProxy

java.lang.Object

hudson.model.AbstractDescribableImpl<ZAProxy>

fr.novia.zaproxyplugin.ZAProxy

All Implemented Interfaces:

hudson.model.Describable<ZAProxy>

public class ZAProxy
extends hudson.model.AbstractDescribableImpl<ZAProxy>

Contains methods to start and execute ZAProxy. Members variables are bind to the config.jelly placed to fr/novia/zaproxyplugin/ZAProxy

Author:

ludovic.roucoux

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZAProxy.ZAProxyDescriptorImpl Descriptor for ZAProxy.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CMD_LINE_CONFIG
static String	CMD_LINE_DAEMON
static String	CMD_LINE_DIR
static String	CMD_LINE_HOST
static String	CMD_LINE_PORT

Constructor Summary

Constructors

Constructor and Description
ZAProxy(boolean autoInstall, String toolUsed, String zapHome, int timeoutInSec, String filenameLoadSession, String targetURL, boolean spiderURL, boolean scanURL, boolean saveReports, List<String> chosenFormats, String filenameReports, boolean saveSession, String filenameSaveSession, String zapDefaultDir, String chosenPolicy, List<ZAPcmdLine> cmdLinesZAP)

Method Summary

Methods

Modifier and Type	Method and Description
void	executeZAP(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener) Execute ZAProxy method following build's setup.
boolean	getAutoInstall()
List<String>	getChosenFormats()
String	getChosenPolicy()
List<ZAPcmdLine>	getCmdLinesZAP()
ZAProxy.ZAProxyDescriptorImpl	getDescriptor()
String	getFilenameLoadSession()
String	getFilenameReports()
String	getFilenameSaveSession()
boolean	getSaveReports()
boolean	getSaveSession()
boolean	getScanURL()
boolean	getSpiderURL()
String	getTargetURL()
int	getTimeoutInSec()
String	getToolUsed()
String	getZapDefaultDir()
String	getZapHome()
void	setZapProxyHost(String zapProxyHost)
void	setZapProxyPort(int zapProxyPort)
void	startZAP(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener) Start ZAProxy using command line.
void	stopZAP(hudson.model.BuildListener listener) Stop ZAproxy if it has been previously started.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CMD_LINE_DIR

public static final String CMD_LINE_DIR

See Also:

Constant Field Values

CMD_LINE_CONFIG

public static final String CMD_LINE_CONFIG

See Also:

Constant Field Values

CMD_LINE_HOST

public static final String CMD_LINE_HOST

See Also:

Constant Field Values

CMD_LINE_PORT

public static final String CMD_LINE_PORT

See Also:

Constant Field Values

CMD_LINE_DAEMON

public static final String CMD_LINE_DAEMON

See Also:

Constant Field Values

Constructor Detail

ZAProxy

@DataBoundConstructor
public ZAProxy(boolean autoInstall,
                            String toolUsed,
                            String zapHome,
                            int timeoutInSec,
                            String filenameLoadSession,
                            String targetURL,
                            boolean spiderURL,
                            boolean scanURL,
                            boolean saveReports,
                            List<String> chosenFormats,
                            String filenameReports,
                            boolean saveSession,
                            String filenameSaveSession,
                            String zapDefaultDir,
                            String chosenPolicy,
                            List<ZAPcmdLine> cmdLinesZAP)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getDescriptor

public ZAProxy.ZAProxyDescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<ZAProxy>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<ZAProxy>

getAutoInstall

public boolean getAutoInstall()

getToolUsed

public String getToolUsed()

getZapHome

public String getZapHome()

getTimeoutInSec

public int getTimeoutInSec()

getFilenameLoadSession

public String getFilenameLoadSession()

getTargetURL

public String getTargetURL()

getSpiderURL

public boolean getSpiderURL()

getScanURL

public boolean getScanURL()

getSaveReports

public boolean getSaveReports()

getChosenFormats

public List<String> getChosenFormats()

getFilenameReports

public String getFilenameReports()

getSaveSession

public boolean getSaveSession()

getFilenameSaveSession

public String getFilenameSaveSession()

getZapDefaultDir

public String getZapDefaultDir()

getChosenPolicy

public String getChosenPolicy()

setZapProxyHost

public void setZapProxyHost(String zapProxyHost)

setZapProxyPort

public void setZapProxyPort(int zapProxyPort)

getCmdLinesZAP

public List<ZAPcmdLine> getCmdLinesZAP()

startZAP

public void startZAP(hudson.model.AbstractBuild<?,?> build,
            hudson.model.BuildListener listener)
              throws Exception

Start ZAProxy using command line. It uses host and port configured in Jenkins admin mode and ZAProxy program is launched in daemon mode (i.e without UI).

Parameters:

build -

listener - the listener to display log during the job execution in jenkins

Throws:

Exception

executeZAP

public void executeZAP(hudson.model.AbstractBuild<?,?> build,
              hudson.model.BuildListener listener)
                throws Exception

Execute ZAProxy method following build's setup.

Parameters:

build -

listener - the listener to display log during the job execution in jenkins

Throws:

Exception

stopZAP

public void stopZAP(hudson.model.BuildListener listener)

Stop ZAproxy if it has been previously started.

Parameters:

listener - the listener to display log during the job execution in jenkins