com.denimgroup.threadfix.remote

Class ThreadFixRestClientImpl

java.lang.Object

com.denimgroup.threadfix.remote.ThreadFixRestClientImpl

All Implemented Interfaces:

ThreadFixRestClient

public class ThreadFixRestClientImpl
extends Object
implements ThreadFixRestClient

Constructor Summary

Constructors

Constructor and Description
ThreadFixRestClientImpl() Default constructor that will read configuration from a local .properties file
ThreadFixRestClientImpl(PropertiesManager manager)
ThreadFixRestClientImpl(String url, String apiKey) Custom constructor for when you want to use the in-memory properties

Method Summary

Methods

Modifier and Type	Method and Description
RestResponse<com.denimgroup.threadfix.data.entities.Application>	addAppUrl(String appId, String url)
RestResponse<com.denimgroup.threadfix.data.entities.Finding>	addDynamicFinding(String applicationId, String vulnType, String severity, String nativeId, String parameter, String longDescription, String fullUrl, String path)
RestResponse<com.denimgroup.threadfix.data.entities.Finding>	addStaticFinding(String applicationId, String vulnType, String severity, String nativeId, String parameter, String longDescription, String filePath, String column, String lineText, String lineNumber)
RestResponse<com.denimgroup.threadfix.data.entities.Application>	addWaf(String appId, String wafId)
RestResponse<com.denimgroup.threadfix.data.entities.ScanQueueTask>	completeTask(String scanQueueTaskId, String filePath, String secureTaskKey)
RestResponse<com.denimgroup.threadfix.data.entities.Application>	createApplication(String teamId, String name, String url)
RestResponse<com.denimgroup.threadfix.data.entities.Organization>	createTeam(String name)
RestResponse<com.denimgroup.threadfix.data.entities.Waf>	createWaf(String name, String type)
RestResponse<String>	failTask(String scanQueueTaskId, String message, String secureTaskKey)
RestResponse<com.denimgroup.threadfix.data.entities.Organization[]>	getAllTeams()
RestResponse<String>	getAllTeamsPrettyPrint()
RestResponse<String>	getRules(String wafId, String appId)
RestResponse<com.denimgroup.threadfix.data.entities.ScanQueueTask>	queueScan(String applicationId, String scannerType)
RestResponse<com.denimgroup.threadfix.data.entities.Task>	requestTask(String scanners, String agentConfig)
RestResponse<com.denimgroup.threadfix.data.entities.Application>	searchForApplicationById(String id)
RestResponse<com.denimgroup.threadfix.data.entities.Application>	searchForApplicationByName(String name, String teamName)
RestResponse<com.denimgroup.threadfix.data.entities.Application>	searchForApplicationByUniqueId(String uniqueId, String teamName)
RestResponse<com.denimgroup.threadfix.data.entities.Organization>	searchForTeamById(String id)
RestResponse<com.denimgroup.threadfix.data.entities.Organization>	searchForTeamByName(String name)
RestResponse<com.denimgroup.threadfix.data.entities.Waf>	searchForWafById(String wafId)
RestResponse<com.denimgroup.threadfix.data.entities.Waf>	searchForWafByName(String name)
RestResponse<VulnerabilityInfo[]>	searchVulnerabilities(List<Integer> genericVulnerabilityIds, List<Integer> teamIds, List<Integer> applicationIds, List<String> scannerNames, List<Integer> genericSeverityValues, Integer numberVulnerabilities, String parameter, String path, Date startDate, Date endDate, Boolean showOpen, Boolean showClosed, Boolean showFalsePositive, Boolean showHidden, Integer numberMerged, Boolean showDefectPresent, Boolean showDefectNotPresent, Boolean showDefectOpen, Boolean showDefectClosed)
void	setKey(String key)
void	setMemoryKey(String key)
void	setMemoryUrl(String url)
RestResponse<com.denimgroup.threadfix.data.entities.Application>	setParameters(String appId, String frameworkType, String repositoryUrl)
RestResponse<String>	setTaskConfig(String appId, String scannerType, String filePath)
void	setUrl(String url)
RestResponse<String>	taskStatusUpdate(String scanQueueTaskId, String message) Determine if we want to pass the taskId as a parameter or if we want to REST it up
RestResponse<com.denimgroup.threadfix.data.entities.Scan>	uploadScan(String applicationId, String filePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadFixRestClientImpl

public ThreadFixRestClientImpl()

Default constructor that will read configuration from a local .properties file

ThreadFixRestClientImpl

public ThreadFixRestClientImpl(PropertiesManager manager)

ThreadFixRestClientImpl

public ThreadFixRestClientImpl(String url,
                       String apiKey)

Custom constructor for when you want to use the in-memory properties

Parameters:

url - URL for the ThreadFix server

apiKey - API key to use when accessing the ThreadFix server

Method Detail

createApplication

public RestResponse<com.denimgroup.threadfix.data.entities.Application> createApplication(String teamId,
                                                                                 String name,
                                                                                 String url)

Specified by:

createApplication in interface ThreadFixRestClient

setParameters

public RestResponse<com.denimgroup.threadfix.data.entities.Application> setParameters(String appId,
                                                                             String frameworkType,
                                                                             String repositoryUrl)

Specified by:

setParameters in interface ThreadFixRestClient

createTeam

public RestResponse<com.denimgroup.threadfix.data.entities.Organization> createTeam(String name)

Specified by:

createTeam in interface ThreadFixRestClient

getRules

public RestResponse<String> getRules(String wafId,
                            String appId)

Specified by:

getRules in interface ThreadFixRestClient

searchForWafByName

public RestResponse<com.denimgroup.threadfix.data.entities.Waf> searchForWafByName(String name)

Specified by:

searchForWafByName in interface ThreadFixRestClient

searchForWafById

public RestResponse<com.denimgroup.threadfix.data.entities.Waf> searchForWafById(String wafId)

Specified by:

searchForWafById in interface ThreadFixRestClient

createWaf

public RestResponse<com.denimgroup.threadfix.data.entities.Waf> createWaf(String name,
                                                                 String type)

Specified by:

createWaf in interface ThreadFixRestClient

addWaf

public RestResponse<com.denimgroup.threadfix.data.entities.Application> addWaf(String appId,
                                                                      String wafId)

Specified by:

addWaf in interface ThreadFixRestClient

Parameters:

appId -

wafId -

Returns:

getAllTeams

public RestResponse<com.denimgroup.threadfix.data.entities.Organization[]> getAllTeams()

Specified by:

getAllTeams in interface ThreadFixRestClient

getAllTeamsPrettyPrint

public RestResponse<String> getAllTeamsPrettyPrint()

Specified by:

getAllTeamsPrettyPrint in interface ThreadFixRestClient

searchForApplicationById

public RestResponse<com.denimgroup.threadfix.data.entities.Application> searchForApplicationById(String id)

Specified by:

searchForApplicationById in interface ThreadFixRestClient

searchForApplicationByName

public RestResponse<com.denimgroup.threadfix.data.entities.Application> searchForApplicationByName(String name,
                                                                                          String teamName)

Specified by:

searchForApplicationByName in interface ThreadFixRestClient

searchForApplicationByUniqueId

public RestResponse<com.denimgroup.threadfix.data.entities.Application> searchForApplicationByUniqueId(String uniqueId,
                                                                                              String teamName)

Specified by:

searchForApplicationByUniqueId in interface ThreadFixRestClient

searchForTeamById

public RestResponse<com.denimgroup.threadfix.data.entities.Organization> searchForTeamById(String id)

Specified by:

searchForTeamById in interface ThreadFixRestClient

searchForTeamByName

public RestResponse<com.denimgroup.threadfix.data.entities.Organization> searchForTeamByName(String name)

Specified by:

searchForTeamByName in interface ThreadFixRestClient

setKey

public void setKey(String key)

Specified by:

setKey in interface ThreadFixRestClient

setUrl

public void setUrl(String url)

Specified by:

setUrl in interface ThreadFixRestClient

setMemoryKey

public void setMemoryKey(String key)

Specified by:

setMemoryKey in interface ThreadFixRestClient

setMemoryUrl

public void setMemoryUrl(String url)

Specified by:

setMemoryUrl in interface ThreadFixRestClient

uploadScan

public RestResponse<com.denimgroup.threadfix.data.entities.Scan> uploadScan(String applicationId,
                                                                   String filePath)

Specified by:

uploadScan in interface ThreadFixRestClient

queueScan

public RestResponse<com.denimgroup.threadfix.data.entities.ScanQueueTask> queueScan(String applicationId,
                                                                           String scannerType)

Specified by:

queueScan in interface ThreadFixRestClient

addAppUrl

public RestResponse<com.denimgroup.threadfix.data.entities.Application> addAppUrl(String appId,
                                                                         String url)

Specified by:

addAppUrl in interface ThreadFixRestClient

requestTask

public RestResponse<com.denimgroup.threadfix.data.entities.Task> requestTask(String scanners,
                                                                    String agentConfig)

Specified by:

requestTask in interface ThreadFixRestClient

taskStatusUpdate

public RestResponse<String> taskStatusUpdate(String scanQueueTaskId,
                                    String message)

Determine if we want to pass the taskId as a parameter or if we want to REST it up

Specified by:

taskStatusUpdate in interface ThreadFixRestClient

Parameters:

scanQueueTaskId -

message -

Returns:

setTaskConfig

public RestResponse<String> setTaskConfig(String appId,
                                 String scannerType,
                                 String filePath)

Specified by:

setTaskConfig in interface ThreadFixRestClient

completeTask

public RestResponse<com.denimgroup.threadfix.data.entities.ScanQueueTask> completeTask(String scanQueueTaskId,
                                                                              String filePath,
                                                                              String secureTaskKey)

Specified by:

completeTask in interface ThreadFixRestClient

failTask

public RestResponse<String> failTask(String scanQueueTaskId,
                            String message,
                            String secureTaskKey)

Specified by:

failTask in interface ThreadFixRestClient

addDynamicFinding

public RestResponse<com.denimgroup.threadfix.data.entities.Finding> addDynamicFinding(String applicationId,
                                                                             String vulnType,
                                                                             String severity,
                                                                             String nativeId,
                                                                             String parameter,
                                                                             String longDescription,
                                                                             String fullUrl,
                                                                             String path)

Specified by:

addDynamicFinding in interface ThreadFixRestClient

addStaticFinding

public RestResponse<com.denimgroup.threadfix.data.entities.Finding> addStaticFinding(String applicationId,
                                                                            String vulnType,
                                                                            String severity,
                                                                            String nativeId,
                                                                            String parameter,
                                                                            String longDescription,
                                                                            String filePath,
                                                                            String column,
                                                                            String lineText,
                                                                            String lineNumber)

Specified by:

addStaticFinding in interface ThreadFixRestClient

searchVulnerabilities

public RestResponse<VulnerabilityInfo[]> searchVulnerabilities(List<Integer> genericVulnerabilityIds,
                                                      List<Integer> teamIds,
                                                      List<Integer> applicationIds,
                                                      List<String> scannerNames,
                                                      List<Integer> genericSeverityValues,
                                                      Integer numberVulnerabilities,
                                                      String parameter,
                                                      String path,
                                                      Date startDate,
                                                      Date endDate,
                                                      Boolean showOpen,
                                                      Boolean showClosed,
                                                      Boolean showFalsePositive,
                                                      Boolean showHidden,
                                                      Integer numberMerged,
                                                      Boolean showDefectPresent,
                                                      Boolean showDefectNotPresent,
                                                      Boolean showDefectOpen,
                                                      Boolean showDefectClosed)

Specified by:

searchVulnerabilities in interface ThreadFixRestClient