org.jenkinsci.plugins.zap

Class ZAPDriver.ZAPDriverDescriptorImpl

java.lang.Object

hudson.model.Descriptor<ZAPDriver>

org.jenkinsci.plugins.zap.ZAPDriver.ZAPDriverDescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable, Serializable

Enclosing class:

ZAPDriver

@Extension
public static class ZAPDriver.ZAPDriverDescriptorImpl
extends hudson.model.Descriptor<ZAPDriver>
implements Serializable

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

See src/main/resources/com/github/jenkinsci/zaproxyplugin/ZAPDriver/*.jelly for the actual HTML fragment for the configuration screen.

See Also:

Serialized Form

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
ZAPDriverDescriptorImpl() In order to load the persisted global configuration, you have to call load() in the constructor.

Method Summary

Modifier and Type	Method and Description
hudson.util.FormValidation	doCheckAuthScript(String authScript) Todo
hudson.util.FormValidation	doCheckExportreportBy(String exportreportBy) Todo
hudson.util.FormValidation	doCheckExportreportFor(String exportreportFor) Todo
hudson.util.FormValidation	doCheckExportreportReportDate(String exportreportReportDate) Todo
hudson.util.FormValidation	doCheckExportreportReportDescription(String exportreportReportDescription) Todo
hudson.util.FormValidation	doCheckExportreportReportVersion(String exportreportReportVersion) Todo
hudson.util.FormValidation	doCheckExportreportScanDate(String exportreportScanDate) Todo
hudson.util.FormValidation	doCheckExportreportScanVersion(String exportreportScanVersion) Todo
hudson.util.FormValidation	doCheckExportreportTitle(String exportreportTitle) Todo
hudson.util.FormValidation	doCheckIncludedURL(String includedURL) Todo
hudson.util.FormValidation	doCheckLoadSession(String loadSession) Todo
hudson.util.FormValidation	doCheckReportFilename(String reportFilename) Performs on-the-fly validation of the form field 'reportFilename'.
hudson.util.FormValidation	doCheckSessionFilename(String sessionFilename) Performs on-the-fly validation of the form field 'sessionFilename'.
hudson.util.ListBoxModel	doFillActiveScanPolicyItems(String zapSettingsDir) List model to choose the policy file to use by ZAProxy scan.
hudson.util.ListBoxModel	doFillAuthScriptItems(String zapSettingsDir) List model to choose the authentication script file to use by ZAProxy scan.
hudson.util.ListBoxModel	doFillLoadSessionItems() List model to choose the ZAP session to use.
hudson.util.ListBoxModel	doFillSelectedExportFormatsItems() List model to choose the export report format
hudson.util.ListBoxModel	doFillSelectedReportFormatsItems() List model to choose the alert report format
hudson.util.ListBoxModel	doFillToolUsedItems() List model to choose the tool used (normally, it should be the ZAP tool).
List<String>	getAllExportFormats()
List<String>	getAllFormats()
String	getDisplayName()
Map<String,ZAPReport>	getMapFormatReport()
void	setWorkspace(hudson.FilePath ws)

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

ZAPDriverDescriptorImpl

public ZAPDriverDescriptorImpl()

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

Method Detail

setWorkspace

public void setWorkspace(hudson.FilePath ws)

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class hudson.model.Descriptor<ZAPDriver>

getMapFormatReport

public Map<String,ZAPReport> getMapFormatReport()

getAllFormats

public List<String> getAllFormats()

getAllExportFormats

public List<String> getAllExportFormats()

doCheckReportFilename

public hudson.util.FormValidation doCheckReportFilename(@QueryParameter(value="reportFilename")
                                                        String reportFilename)

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

Parameters:

reportFilename - of type @QueryParameter String: 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.

doCheckSessionFilename

public hudson.util.FormValidation doCheckSessionFilename(@QueryParameter(value="sessionFilename")
                                                         String sessionFilename)

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

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:

sessionFilename - of type @QueryParameter String: 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.

doCheckLoadSession

public hudson.util.FormValidation doCheckLoadSession(@QueryParameter(value="loadSession")
                                                     String loadSession)

Todo

Parameters:

loadSession -

Returns:

doCheckIncludedURL

public hudson.util.FormValidation doCheckIncludedURL(@QueryParameter(value="includedURL")
                                                     String includedURL)

Todo

Parameters:

includedURL -

Returns:

doCheckAuthScript

public hudson.util.FormValidation doCheckAuthScript(@QueryParameter(value="authScript")
                                                    String authScript)

Todo

Parameters:

authScript -

Returns:

doCheckExportreportTitle

public hudson.util.FormValidation doCheckExportreportTitle(@QueryParameter(value="exportreportTitle")
                                                           String exportreportTitle)

Todo

Parameters:

exportreportTitle -

Returns:

doCheckExportreportBy

public hudson.util.FormValidation doCheckExportreportBy(@QueryParameter(value="exportreportBy")
                                                        String exportreportBy)

Todo

Parameters:

exportreportBy -

Returns:

doCheckExportreportFor

public hudson.util.FormValidation doCheckExportreportFor(@QueryParameter(value="exportreportFor")
                                                         String exportreportFor)

Todo

Parameters:

exportreportFor -

Returns:

doCheckExportreportScanDate

public hudson.util.FormValidation doCheckExportreportScanDate(@QueryParameter(value="exportreportScanDate")
                                                              String exportreportScanDate)

Todo

Parameters:

exportreportScanDate -

Returns:

doCheckExportreportReportDate

public hudson.util.FormValidation doCheckExportreportReportDate(@QueryParameter(value="exportreportReportDate")
                                                                String exportreportReportDate)

Todo

Parameters:

exportreportReportDate -

Returns:

doCheckExportreportScanVersion

public hudson.util.FormValidation doCheckExportreportScanVersion(@QueryParameter(value="exportreportScanVersion")
                                                                 String exportreportScanVersion)

Todo

Parameters:

exportreportScanVersion -

Returns:

doCheckExportreportReportVersion

public hudson.util.FormValidation doCheckExportreportReportVersion(@QueryParameter(value="exportreportReportVersion")
                                                                   String exportreportReportVersion)

Todo

Parameters:

exportreportReportVersion -

Returns:

doCheckExportreportReportDescription

public hudson.util.FormValidation doCheckExportreportReportDescription(@QueryParameter(value="exportreportReportDescription")
                                                                       String exportreportReportDescription)

Todo

Parameters:

exportreportReportDescription -

Returns:

doFillSelectedReportFormatsItems

public hudson.util.ListBoxModel doFillSelectedReportFormatsItems()

List model to choose the alert report format

Returns:

a ListBoxModel

doFillSelectedExportFormatsItems

public hudson.util.ListBoxModel doFillSelectedExportFormatsItems()

List model to choose the export report format

Returns:

a ListBoxModel

doFillToolUsedItems

public hudson.util.ListBoxModel doFillToolUsedItems()

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

Returns:

a ListBoxModel

doFillActiveScanPolicyItems

public hudson.util.ListBoxModel doFillActiveScanPolicyItems(@QueryParameter
                                                            String zapSettingsDir)

List model to choose the policy file to use by ZAProxy scan. It's called on the remote machine (if present) to load all policy files in the ZAP default dir of the build's machine.

Parameters:

zapSettingsDir - of type @QueryParameter String: A string that represents an absolute path to the directory that ZAP uses.

Returns:

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

doFillAuthScriptItems

public hudson.util.ListBoxModel doFillAuthScriptItems(@QueryParameter
                                                      String zapSettingsDir)

List model to choose the authentication script file to use by ZAProxy scan. It's called on the remote machine (if present) to load all authentication script files in the ZAP default dir of the build's machine. The jenkins job must be started once in order to create the workspace, so this method can load the list of authentication scripts the authentication scripts must be stored in this directory : /scripts/authentication

Parameters:

zapSettingsDir - of type @QueryParameter String: A string that represents an absolute path to the directory that ZAP uses.

Returns:

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

doFillLoadSessionItems

public hudson.util.ListBoxModel doFillLoadSessionItems()
                                                throws IOException,
                                                       InterruptedException

List model to choose the ZAP session to use. It's called on the remote machine (if present) to load all session files in the build's workspace.

Returns:

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

Throws:

InterruptedException

IOException