fr.novia.zaproxyplugin

Class ZAProxy.ZAProxyDescriptorImpl

java.lang.Object

hudson.model.Descriptor<ZAProxy>

fr.novia.zaproxyplugin.ZAProxy.ZAProxyDescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

ZAProxy

@Extension
public static class ZAProxy.ZAProxyDescriptorImpl
extends hudson.model.Descriptor<ZAProxy>

Descriptor for ZAProxy. Used as a singleton. The class is marked as public so that it can be accessed from views.

See src/main/resources/fr/novia/zaproxyplugin/ZAProxy/*.jelly for the actual HTML fragment for the configuration screen.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
ZAProxy.ZAProxyDescriptorImpl() In order to load the persisted global configuration, you have to call load() in the constructor.

Method Summary

Methods

Modifier and Type	Method and Description
hudson.util.FormValidation	doCheckFilenameReports(String filenameReports) Performs on-the-fly validation of the form field 'filenameReports'.
hudson.util.FormValidation	doCheckFilenameSaveSession(String filenameLoadSession, String filenameSaveSession) Performs on-the-fly validation of the form field 'filenameSaveSession'.
hudson.util.ListBoxModel	doFillChosenFormatsItems() List model to choose the alert report format
hudson.util.ListBoxModel	doFillChosenPolicyItems(String zapDefaultDir) List model to choose the policy file to use by ZAProxy scan.
hudson.util.ListBoxModel	doFillFilenameLoadSessionItems(String workspace) List model to choose the ZAP session to use.
hudson.util.ListBoxModel	doFillToolUsedItems() List model to choose the tool used (normally, it should be the ZAProxy tool)
List<String>	getAllFormats()
String	getDisplayName()
Map<String,ZAPreport>	getMapFormatReport()

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

ZAProxy.ZAProxyDescriptorImpl

public ZAProxy.ZAProxyDescriptorImpl()

In order to load the persisted global configuration, you have to call load() in the constructor.

Method Detail

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class hudson.model.Descriptor<ZAProxy>

getMapFormatReport

public Map<String,ZAPreport> getMapFormatReport()

getAllFormats

public List<String> getAllFormats()

doCheckFilenameReports

public hudson.util.FormValidation doCheckFilenameReports(@QueryParameter(value="filenameReports")
                                                String filenameReports)
                                                  throws IOException,
                                                         javax.servlet.ServletException

Performs on-the-fly validation of the form field 'filenameReports'.

Parameters:

filenameReports - This parameter receives the value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.

Note that returning FormValidation.error(String) does not prevent the form from being saved. It just means that a message will be displayed to the user.

Throws:

IOException

javax.servlet.ServletException

doCheckFilenameSaveSession

public hudson.util.FormValidation doCheckFilenameSaveSession(@QueryParameter(value="filenameLoadSession")
                                                    String filenameLoadSession,
                                                    @QueryParameter(value="filenameSaveSession")
                                                    String filenameSaveSession)
                                                      throws IOException,
                                                             javax.servlet.ServletException

Performs on-the-fly validation of the form field 'filenameSaveSession'.

If the user wants to save session whereas a session is already loaded, the relative path to the saved session must be different from the relative path to the loaded session.

Parameters:

filenameLoadSession - Parameter to compare with filenameSaveSession.

filenameSaveSession - This parameter receives the value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.

Note that returning FormValidation.error(String) does not prevent the form from being saved. It just means that a message will be displayed to the user.

Throws:

IOException

javax.servlet.ServletException

doFillChosenFormatsItems

public hudson.util.ListBoxModel doFillChosenFormatsItems()

List model to choose the alert report format

Returns:

a ListBoxModel

doFillToolUsedItems

public hudson.util.ListBoxModel doFillToolUsedItems()

List model to choose the tool used (normally, it should be the ZAProxy tool)

Returns:

a ListBoxModel

doFillChosenPolicyItems

public hudson.util.ListBoxModel doFillChosenPolicyItems(@QueryParameter
                                               String zapDefaultDir)

List model to choose the policy file to use by ZAProxy scan.

Parameters:

zapDefaultDir - A string that represents an absolute path to the directory that ZAP uses.

Returns:

a ListBoxModel. It can be empty if zapDefaultDir doesn't contain any policy file.

doFillFilenameLoadSessionItems

public hudson.util.ListBoxModel doFillFilenameLoadSessionItems(@QueryParameter
                                                      String workspace)

List model to choose the ZAP session to use.

Parameters:

workspace - the location to load ZAP sessions (the workspace of the current job)

Returns:

a ListBoxModel. It can be empty if the workspace doesn't contain any ZAP sessions.