Skip navigation links
A B C D E F G H I J L P R S T U V W 

A

ApiSerializer - Class in com.rapid7.appspider
 
ApiSerializer(LoggerFacade) - Constructor for class com.rapid7.appspider.ApiSerializer
 
asJson(HttpEntity) - Method in class com.rapid7.appspider.ContentHelper
converts the provided HttpEntity to a JSONObject
asMapOfStringToString(String, String, Optional<JSONObject>) - Method in class com.rapid7.appspider.ContentHelper
extracts the key/value pairs from JSONObject and returns them as a Map{String, String}
AuthenticationModel - Class in com.rapid7.appspider.models
Storage class containing all the information need to authenticate
AuthenticationModel(String, String) - Constructor for class com.rapid7.appspider.models.AuthenticationModel
instantiates a new instance of the AuthenticationModel class with no client Id
AuthenticationModel(String, String, Optional<String>) - Constructor for class com.rapid7.appspider.models.AuthenticationModel
instantiates a new instance of the AuthenticationModel class ensuring that username and password are both non-null and non-empty

B

buildAuthenticationModel() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
buildGetAcceptionApplicatonJson(String, String) - Method in interface com.rapid7.appspider.ClientService
builds a HttpGet request object for the given endpoint using authToken as basic authentication header.
buildGetAcceptionApplicatonJson(String, String) - Method in class com.rapid7.appspider.HttpClientService
builds a HttpGet request object for the given endpoint using authToken as basic authentication header.
buildGetRequestUsingFormUrlEncoding(String, String) - Method in interface com.rapid7.appspider.ClientService
Builds a HttpGet request object for the endpoint given by endpoint using authToken as basic authentication header
buildGetRequestUsingFormUrlEncoding(String, String, NameValuePair...) - Method in interface com.rapid7.appspider.ClientService
builds a HttpGet request object for the given endpoint using authToken as basic authentication header and params as additional URL key/value parameters
buildGetRequestUsingFormUrlEncoding(String, String) - Method in class com.rapid7.appspider.HttpClientService
Builds a HttpGet request object for the endpoint given by endpoint using authToken as basic authentication header
buildGetRequestUsingFormUrlEncoding(String, String, NameValuePair...) - Method in class com.rapid7.appspider.HttpClientService
builds a HttpGet request object for the given endpoint using authToken as basic authentication header and params as additional URL key/value parameters
buildPostRequestUsingApplicationJson(String, HttpEntity) - Method in interface com.rapid7.appspider.ClientService
builds a HttpPost request object for the given endpoint containing the provided body content body will be posted using Content-Type of application/json
buildPostRequestUsingApplicationJson(String, HttpEntity) - Method in class com.rapid7.appspider.HttpClientService
builds a HttpPost request object for the given endpoint containing the provided body content body will be posted using Content-Type of application/json
buildPostRequestUsingFormUrlEncoding(String, String, NameValuePair...) - Method in interface com.rapid7.appspider.ClientService
builds a HttpPost request object for the given endpoint containing the provided body content body will be posted using Content-Type as application/x-www-form-urlencoded
buildPostRequestUsingFormUrlEncoding(String, String, NameValuePair...) - Method in class com.rapid7.appspider.HttpClientService
builds a HttpPost request object for the given endpoint containing the provided body content body will be posted using Content-Type as application/x-www-form-urlencoded

C

ClientIdNamePair - Class in com.rapid7.appspider.datatransferobjects
 
ClientIdNamePair(String, String) - Constructor for class com.rapid7.appspider.datatransferobjects.ClientIdNamePair
 
ClientService - Interface in com.rapid7.appspider
 
com.rapid7.appspider - package com.rapid7.appspider
 
com.rapid7.appspider.datatransferobjects - package com.rapid7.appspider.datatransferobjects
 
com.rapid7.appspider.models - package com.rapid7.appspider.models
 
com.rapid7.jenkinspider - package com.rapid7.jenkinspider
 
configure(StaplerRequest, JSONObject) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
ContentHelper - Class in com.rapid7.appspider
parsing and serializing helper methods for handling JSONObject manipulation
ContentHelper(LoggerFacade) - Constructor for class com.rapid7.appspider.ContentHelper
 

D

DescriptorImp() - Constructor for class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
doCheckappSpiderEntUrl(String) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
Performs on-the-fly validation of the form field 'name'.
doFillClientNameItems() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
Method for populating the dropdown menu with all the available scan configs
doFillConfigNameItems(String) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
Method for populating the dropdown menu with all the available scan configs
doFillScanConfigEngineGroupNameItems() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
Method for populating the dropdown menu with all the available scan engine groups
doTestCredentials(boolean, String, String, Secret) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
calls the login endpoint with the provided credentials reporting success/failure back to the user via form validation
doValidateNewScanConfig(String, String) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 

E

EnterpriseClient - Interface in com.rapid7.appspider
 
EnterpriseRestClient - Class in com.rapid7.appspider
Provides methods to communicating with AppSpider Enterprise while obsuring the implementation details of that communication.
EnterpriseRestClient(HttpClientService, String, ApiSerializer, ContentHelper, LoggerFacade) - Constructor for class com.rapid7.appspider.EnterpriseRestClient
Instantiates a new instance of the EnterpriseClient class
entityFrom(JSONObject) - Method in class com.rapid7.appspider.ContentHelper
builds a StringEntity using the string provided by jsonObject.toString()
entityFrom(NameValuePair...) - Method in class com.rapid7.appspider.ContentHelper
simple wrapper around entityFrom(JSONObject) that uses jsonFrom to build the JSONObject
executeEntityRequest(HttpRequestBase) - Method in class com.rapid7.appspider.HttpClientService
executes the provided HttpRequestBase returning the result as a HttpEntity
executeJsonRequest(HttpRequestBase) - Method in interface com.rapid7.appspider.ClientService
executes the provided HttpRequestBase returning the result as a JSONObject
executeJsonRequest(HttpRequestBase) - Method in class com.rapid7.appspider.HttpClientService
executes the provided HttpRequestBase returning the result as a JSONObject

F

findByConfigName(JSONArray, String) - Method in class com.rapid7.appspider.ApiSerializer
returns the JSONObject for the item in configs with "Name" matching name if found; otherwise Optional.empty()

G

getAppSpiderAllowSelfSignedCertificate() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
getAppSpiderClientId() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
getAppSpiderClientName() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
getAppSpiderEntUrl() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
getAppSpiderPassword() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
getAppSpiderUsername() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
getArrayFrom(JSONObject, String) - Method in class com.rapid7.appspider.ContentHelper
returns JSONArray from jsonObject matching key
getBooleansFrom(JSONObject, String...) - Method in class com.rapid7.appspider.ApiSerializer
returns true if all given keys in jsonObject are true
getClient() - Method in class com.rapid7.appspider.HttpClientFactory
gets a closeble HttpClient configured for TLS 1.2
getClientId() - Method in class com.rapid7.appspider.models.AuthenticationModel
Gets the client id if present; otherwise throws a NoSuchElementException
getClientIdNamePairs(JSONArray) - Method in class com.rapid7.appspider.ApiSerializer
returns a list of ClientIdNamePair objects extracted from given JSONArray
getClientName() - Method in class com.rapid7.jenkinspider.PostBuildScan
 
getClientNameIdPairs(String) - Method in interface com.rapid7.appspider.EnterpriseClient
gets an array of all name/id pairs of clients that the authorized user can access
getClientNameIdPairs(String) - Method in class com.rapid7.appspider.EnterpriseRestClient
gets an array of all name/id pairs of clients that the authorized user can access
getConfigName() - Method in class com.rapid7.appspider.ScanSettings
 
getConfigName() - Method in class com.rapid7.jenkinspider.PostBuildScan
 
getConfigNames(JSONArray) - Method in class com.rapid7.appspider.ApiSerializer
returns List{String} of all scan config names found in configs
getConfigNames(String) - Method in interface com.rapid7.appspider.EnterpriseClient
returns String[] of scan config names
getConfigNames(String) - Method in class com.rapid7.appspider.EnterpriseRestClient
returns String[] of scan config names
getDescriptor() - Method in class com.rapid7.jenkinspider.PostBuildScan
 
getDisplayName() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
getEnableScan() - Method in class com.rapid7.appspider.ScanSettings
 
getEnableScan() - Method in class com.rapid7.jenkinspider.PostBuildScan
 
getEngineGroupIdFromName(String, String) - Method in interface com.rapid7.appspider.EnterpriseClient
fetches the unique id of the engine group given by engineGroupName
getEngineGroupIdFromName(String, String) - Method in class com.rapid7.appspider.EnterpriseRestClient
fetches the unique id of the engine group given by engineGroupName
getEngineGroupNamesForClient(String) - Method in interface com.rapid7.appspider.EnterpriseClient
fetches the names of available engine groups
getEngineGroupNamesForClient(String) - Method in class com.rapid7.appspider.EnterpriseRestClient
fetches the names of available engine groups
getGenerateReport() - Method in class com.rapid7.appspider.ScanSettings
 
getId() - Method in class com.rapid7.appspider.datatransferobjects.ClientIdNamePair
 
getId() - Method in class com.rapid7.appspider.Scan
returns the current scan id, this will be empty until process has been called
getInputStream(HttpEntity) - Method in class com.rapid7.appspider.ContentHelper
returns InputStream for the content of entity
getIsSuccess(JSONObject) - Method in class com.rapid7.appspider.ApiSerializer
returns the value of "IsSuccess" from the provided jsonObject if non-null; otherwise, false
getName() - Method in class com.rapid7.appspider.datatransferobjects.ClientIdNamePair
 
getNewConfigName() - Method in class com.rapid7.appspider.ScanSettings
 
getNewConfigUrl() - Method in class com.rapid7.appspider.ScanSettings
 
getPassword() - Method in class com.rapid7.appspider.models.AuthenticationModel
gets the password value
getReport() - Method in class com.rapid7.jenkinspider.PostBuildScan
 
getReportName() - Method in class com.rapid7.appspider.ScanSettings
 
getReportName() - Method in class com.rapid7.jenkinspider.PostBuildScan
 
getReportZip(String, String) - Method in interface com.rapid7.appspider.EnterpriseClient
provides InputStream for the request report zip
getReportZip(String, String) - Method in class com.rapid7.appspider.EnterpriseRestClient
provides InputStream for the request report zip
getRequiredMonitorService() - Method in class com.rapid7.jenkinspider.PostBuildScan
 
getResultIsSuccess(JSONObject) - Method in class com.rapid7.appspider.ApiSerializer
returns the value of "IsSuccess" and "Result" from the provided jsonObject if non-null; otherwise, false
getScanConfigEngineGroupName() - Method in class com.rapid7.appspider.ScanSettings
 
getScanConfigEngineGroupName() - Method in class com.rapid7.jenkinspider.PostBuildScan
 
getScanConfigEngines() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
getScanConfigId(JSONObject) - Method in class com.rapid7.appspider.ApiSerializer
 
getScanConfigNames() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
getScanConfigXml(Template, String, URL) - Method in class com.rapid7.appspider.ApiSerializer
constructs scan config XML document using template with provided name and target
getScanId() - Method in class com.rapid7.appspider.datatransferobjects.ScanResult
 
getScanResult(JSONObject) - Method in class com.rapid7.appspider.ApiSerializer
 
getScanStatus(String, String) - Method in interface com.rapid7.appspider.EnterpriseClient
gets the current status of the scan identified by scanId
getScanStatus(String, String) - Method in class com.rapid7.appspider.EnterpriseRestClient
gets the current status of the scan identified by scanId
getStatus(JSONObject) - Method in class com.rapid7.appspider.ApiSerializer
returns the value of "Status" from the provided jsonObject if non-null and Status is not empty; otherwise
getStatusPollTime() - Method in class com.rapid7.appspider.ScanSettings
 
getTextHtmlOrXmlContent(HttpEntity) - Method in class com.rapid7.appspider.ContentHelper
returns text/html or text/html content from enttity if found; otherwise Optional.empty()
getTokenOrEmpty(JSONObject) - Method in class com.rapid7.appspider.ApiSerializer
if jsonObject contains "IsSuccess" with value of true then value of "Token" if non-empty is returned within an Optional; otherwise Optional.empty()
getUrl() - Method in interface com.rapid7.appspider.EnterpriseClient
returns the full URL for the enterprise rest endpoint
getUrl() - Method in class com.rapid7.appspider.EnterpriseRestClient
returns the full URL for the enterprise rest endpoint
getUsername() - Method in class com.rapid7.appspider.models.AuthenticationModel
Get the username value
getVulnerabilitiesSummaryXml(String, String) - Method in interface com.rapid7.appspider.EnterpriseClient
gets the vulnerability summary XML as a String
getVulnerabilitiesSummaryXml(String, String) - Method in class com.rapid7.appspider.EnterpriseRestClient
gets the vulnerability summary XML as a String

H

hasClientId() - Method in class com.rapid7.appspider.models.AuthenticationModel
Returns whether this object contains a clientId or not
hasReport(String, String) - Method in interface com.rapid7.appspider.EnterpriseClient
determines if a scan identified by scanId has a report or not
hasReport(String, String) - Method in class com.rapid7.appspider.EnterpriseRestClient
determines if a scan identified by scanId has a report or not
HttpClientFactory - Class in com.rapid7.appspider
HttpClients configured to use TLS 1.2
HttpClientFactory(boolean) - Constructor for class com.rapid7.appspider.HttpClientFactory
 
HttpClientService - Class in com.rapid7.appspider
 
HttpClientService(HttpClient, ContentHelper, LoggerFacade) - Constructor for class com.rapid7.appspider.HttpClientService
 

I

info(String) - Method in interface com.rapid7.appspider.LoggerFacade
 
info(String) - Method in class com.rapid7.appspider.PrintStreamLoggerFacade
 
isApplicable(Class<? extends AbstractProject>) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
isAppSpiderEnableMultiClientOrSysAdmin() - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
isScanFinished(String, String) - Method in interface com.rapid7.appspider.EnterpriseClient
determines if the scan identified by scanId has finished
isScanFinished(String, String) - Method in class com.rapid7.appspider.EnterpriseRestClient
determines if the scan identified by scanId has finished
isSuccess() - Method in class com.rapid7.appspider.datatransferobjects.ScanResult
 
isSuccessStatusCode(HttpResponse) - Static method in class com.rapid7.appspider.Utility
determines if the response was successful based on status code

J

jsonFrom(NameValuePair...) - Method in class com.rapid7.appspider.ContentHelper
builds a simple JSON object from name value pairs

L

LoggerFacade - Interface in com.rapid7.appspider
 
login(AuthenticationModel) - Method in interface com.rapid7.appspider.EnterpriseClient
calls the /Authentication/Login endpoint with provided details
login(AuthenticationModel) - Method in class com.rapid7.appspider.EnterpriseRestClient
calls the /Authentication/Login endpoint with provided details

P

pairFrom(String, String) - Method in class com.rapid7.appspider.ContentHelper
simple wrapper around BasicNameValuePair constructor provided to shorten syntax
perform(AbstractBuild<?, ?>, Launcher, BuildListener) - Method in class com.rapid7.jenkinspider.PostBuildScan
PostBuildScan - Class in com.rapid7.jenkinspider
Created by nbugash on 20/07/15.
PostBuildScan(String, String, String, Boolean, Boolean, String, String, String) - Constructor for class com.rapid7.jenkinspider.PostBuildScan
 
PostBuildScan.DescriptorImp - Class in com.rapid7.jenkinspider
Descriptor for PostBuildScan.
println(String) - Method in interface com.rapid7.appspider.LoggerFacade
 
println(String) - Method in class com.rapid7.appspider.PrintStreamLoggerFacade
 
PrintStreamLoggerFacade - Class in com.rapid7.appspider
 
PrintStreamLoggerFacade(PrintStream) - Constructor for class com.rapid7.appspider.PrintStreamLoggerFacade
 
process(AuthenticationModel) - Method in class com.rapid7.appspider.Scan
 

R

Report - Class in com.rapid7.appspider
 
Report(EnterpriseClient, ScanSettings, LoggerFacade) - Constructor for class com.rapid7.appspider.Report
 
resetNewConfigValues() - Method in class com.rapid7.appspider.ScanSettings
 
responseToJSONObject(HttpResponse, String) - Method in class com.rapid7.appspider.ContentHelper
extracts the response content into a JSONObject
runScanByConfigName(String, String) - Method in interface com.rapid7.appspider.EnterpriseClient
starts a new scan using configuration matching configName
runScanByConfigName(String, String) - Method in class com.rapid7.appspider.EnterpriseRestClient
starts a new scan using configuration matching configName

S

saveConfig(String, String, URL, String) - Method in interface com.rapid7.appspider.EnterpriseClient
calls the /Configs/SaveConfig endpoint using the provided data to create or update a configuration
saveConfig(String, String, URL, String) - Method in class com.rapid7.appspider.EnterpriseRestClient
calls the /Configs/SaveConfig endpoint using the provided data to create or update a configuration
saveReport(AuthenticationModel, String, FilePath) - Method in class com.rapid7.appspider.Report
 
Scan - Class in com.rapid7.appspider
 
Scan(EnterpriseClient, ScanSettings, LoggerFacade) - Constructor for class com.rapid7.appspider.Scan
 
ScanResult - Class in com.rapid7.appspider.datatransferobjects
 
ScanResult(boolean, String) - Constructor for class com.rapid7.appspider.datatransferobjects.ScanResult
 
ScanResult(JSONObject) - Constructor for class com.rapid7.appspider.datatransferobjects.ScanResult
 
ScanSettings - Class in com.rapid7.appspider
Storage class for scan settings provided by Jenkins
ScanSettings(String, String, Boolean, Boolean, String, String, String) - Constructor for class com.rapid7.appspider.ScanSettings
Constructs a DTO style container object storing scan settings from Jenkins
setAppSpiderAllowSelfSignedCertificate(boolean) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
setAppSpiderClientId(String) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
setAppSpiderClientName(String) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
setAppSpiderEnableMultiClientOrSysAdmin(boolean) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
setAppSpiderEntUrl(String) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
setAppSpiderPassword(Secret) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
setAppSpiderUsername(String) - Method in class com.rapid7.jenkinspider.PostBuildScan.DescriptorImp
 
setConfigName(String) - Method in class com.rapid7.appspider.ScanSettings
 
severe(String) - Method in interface com.rapid7.appspider.LoggerFacade
 
severe(String) - Method in class com.rapid7.appspider.PrintStreamLoggerFacade
 

T

testAuthentication(AuthenticationModel) - Method in interface com.rapid7.appspider.EnterpriseClient
calls the /Authentication/Login endpoint with provided details returning true if credentials are valid
testAuthentication(AuthenticationModel) - Method in class com.rapid7.appspider.EnterpriseRestClient
calls the /Authentication/Login endpoint with provided details returning true if credentials are valid
toStringArray(List<String>) - Static method in class com.rapid7.appspider.Utility
converts ArrayList{String} to String[]

U

Utility - Class in com.rapid7.appspider
various utility merthods that have no better home

V

verbose(String) - Method in interface com.rapid7.appspider.LoggerFacade
 
verbose(String) - Method in class com.rapid7.appspider.PrintStreamLoggerFacade
 

W

warn(String) - Method in interface com.rapid7.appspider.LoggerFacade
 
warn(String) - Method in class com.rapid7.appspider.PrintStreamLoggerFacade
 
A B C D E F G H I J L P R S T U V W 
Skip navigation links

Copyright © 2016–2021. All rights reserved.