com.rapid7.jenkinspider

Class PostBuildScan.DescriptorImp

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Publisher>

com.rapid7.jenkinspider.PostBuildScan.DescriptorImp

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

PostBuildScan

@Extension
public static final class PostBuildScan.DescriptorImp
extends BuildStepDescriptor<Publisher>

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

See src/main/resources/hudson/plugins/hello_world/HelloWorldBuilder/*.jelly for the actual HTML fragment for the configuration screen.

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, 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
DescriptorImp()

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
FormValidation	doCheckappSpiderEntUrl(String value) Performs on-the-fly validation of the form field 'name'.
ListBoxModel	doFillConfigNameItems() Method for populating the dropdown menu with all the available scan configs
ListBoxModel	doFillScanConfigEngineGroupNameItems() Method for populating the dropdown menu with all the available scan engine groups
FormValidation	doTestCredentials(boolean allowSelfSignedCertificate, String appSpiderEntUrl, String username, String password) calls the login endpoint with the provided credentials reporting success/failure back to the user via form validation
FormValidation	doValidateNewScanConfig(String scanConfigName, String scanConfigUrl)
boolean	getAppSpiderAllowSelfSignedCertificate()
String	getAppSpiderEntUrl()
Secret	getAppSpiderPassword()
String	getAppSpiderUsername()
String	getDisplayName()
String[]	getScanConfigEngines()
String[]	getScanConfigNames()
boolean	isApplicable(Class<? extends AbstractProject> aClass)
void	setAppSpiderAllowSelfSignedCertificate(boolean appSpiderAllowSelfSignedCertificate)
void	setAppSpiderEntUrl(String appSpiderEntUrl)
void	setAppSpiderPassword(Secret appSpiderPassword)
void	setAppSpiderUsername(String appSpiderUsername)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, 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

DescriptorImp

public DescriptorImp()

Method Detail

doCheckappSpiderEntUrl

public FormValidation doCheckappSpiderEntUrl(@QueryParameter
                                             String value)

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

Parameters:

value - 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.

isApplicable

public boolean isApplicable(Class<? extends AbstractProject> aClass)

Specified by:

isApplicable in class BuildStepDescriptor<Publisher>

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<Publisher>

Returns:

Display Name of the plugin

getAppSpiderEntUrl

public String getAppSpiderEntUrl()

setAppSpiderEntUrl

public void setAppSpiderEntUrl(String appSpiderEntUrl)

getAppSpiderUsername

public String getAppSpiderUsername()

setAppSpiderUsername

public void setAppSpiderUsername(String appSpiderUsername)

getAppSpiderPassword

public Secret getAppSpiderPassword()

setAppSpiderPassword

public void setAppSpiderPassword(Secret appSpiderPassword)

getAppSpiderAllowSelfSignedCertificate

public boolean getAppSpiderAllowSelfSignedCertificate()

setAppSpiderAllowSelfSignedCertificate

public void setAppSpiderAllowSelfSignedCertificate(boolean appSpiderAllowSelfSignedCertificate)

getScanConfigNames

public String[] getScanConfigNames()

getScanConfigEngines

public String[] getScanConfigEngines()

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject formData)
                  throws Descriptor.FormException

Overrides:

configure in class Descriptor<Publisher>

Throws:

Descriptor.FormException

doFillConfigNameItems

public ListBoxModel doFillConfigNameItems()

Method for populating the dropdown menu with all the available scan configs

Returns:

ListBoxModel containing the scan config names

doFillScanConfigEngineGroupNameItems

public ListBoxModel doFillScanConfigEngineGroupNameItems()

Method for populating the dropdown menu with all the available scan engine groups

Returns:

ListBoxModel containing engine details

doTestCredentials

public FormValidation doTestCredentials(@QueryParameter(value="appSpiderAllowSelfSignedCertificate")
                                        boolean allowSelfSignedCertificate,
                                        @QueryParameter(value="appSpiderEntUrl")
                                        String appSpiderEntUrl,
                                        @QueryParameter(value="appSpiderUsername")
                                        String username,
                                        @QueryParameter(value="appSpiderPassword")
                                        String password)

calls the login endpoint with the provided credentials reporting success/failure back to the user via form validation

Parameters:

allowSelfSignedCertificate - If true certificate errors will be ignored, only meaningful if URL is using https

appSpiderEntUrl - Full URL path including protocol to the appspider rest api endpoint

username - Username used for authentication

password - Password used for authentication

Returns:

FormValidation result of the credentials test

doValidateNewScanConfig

public FormValidation doValidateNewScanConfig(@QueryParameter(value="scanConfigName")
                                              String scanConfigName,
                                              @QueryParameter(value="scanConfigUrl")
                                              String scanConfigUrl)