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

Modifier and Type	Method and Description
RestResponse<Application>	addAppTag(String appId, String tagId)
RestResponse<Application>	addAppUrl(String appId, String url)
RestResponse<Finding>	addDynamicFinding(String applicationId, String vulnType, String severity, String nativeId, String parameter, String longDescription, String fullUrl, String path)
RestResponse<Finding>	addStaticFinding(String applicationId, String vulnType, String severity, String nativeId, String parameter, String longDescription, String filePath, String column, String lineText, String lineNumber)
RestResponse<String>	addVulnComment(Integer vulnId, String comment, String commentTagIds)
RestResponse<Application>	addWaf(String appId, String wafId)
RestResponse<Object>	applicationSetDefectTracker(String applicationId, String defectTrackerId, String username, String password, String projectName)
RestResponse<Application>	createApplication(String teamId, String name, String url)
RestResponse<Tag>	createTag(String name, String tagType)
RestResponse<Organization>	createTeam(String name)
RestResponse<Waf>	createWaf(String name, String type)
RestResponse<String>	deleteChannelFilter(String id)
RestResponse<String>	deleteCICDPolicy(String filePath)
RestResponse<String>	deletePolicy(String policyId)
RestResponse<String>	deleteScanResultFilter(String id)
RestResponse<String>	deleteScheduledEmailReport(String scheduledEmailReportId)
RestResponse<String>	deleteTeam(String teamId)
RestResponse<String>	deleteVulnerabilityFilter(String vulnerabilityFilterId)
RestResponse<String>	editSeverityFilter(String info, String low, String medium, String high, String critical, String enabled, String appId, String teamId)
RestResponse<Tag[]>	getAllTags()
RestResponse<Organization[]>	getAllTeams()
RestResponse<String>	getAllTeamsPrettyPrint()
RestResponse<String>	getCICDPolicy(String fileName)
RestResponse<DynamicFormField[]>	getDefectTrackerFields(Integer appId)
RestResponse<DynamicFormField[]>	getDefectTrackerFields(Integer appId, Integer appTrackerId)
RestResponse<String>	getRules(String wafId, String appId)
RestResponse<Scan[]>	getScansForApplication(String applicationId)
RestResponse<Map>	getTags()
RestResponse<Waf[]>	getWafs()
RestResponse<String[]>	listCICDPolicies()
RestResponse<Object>	listDefectTrackerProjects(String defectTrackerId)
RestResponse<Object>	listDefectTrackerTypes()
RestResponse<DefectTracker>	newDefectTracker(String defectTrackerTypeId, String name, String url, String defaultUsername, String defaultPassword, String defaultProductName)
RestResponse<ScanQueueTask>	queueScan(String applicationId, String scannerType)
RestResponse<ScanQueueTask>	queueScan(String applicationId, String scannerType, String targetURL, String scanConfigId)
RestResponse<Application>	removeAppTag(String appId, String tagId)
RestResponse<String>	removeTag(String tagId)
RestResponse<Application>	searchForApplicationById(String id)
RestResponse<Application>	searchForApplicationByName(String name, String teamName)
RestResponse<Application>	searchForApplicationInTeamByUniqueId(String uniqueId, String teamName)
RestResponse<Application[]>	searchForApplicationsByTagId(String tagId)
RestResponse<Application[]>	searchForApplicationsByUniqueId(String uniqueId)
RestResponse<Scan>	searchForScanById(String scanId)
RestResponse<Organization>	searchForTeamById(String id)
RestResponse<Organization>	searchForTeamByName(String name)
RestResponse<Waf>	searchForWafById(String wafId)
RestResponse<Waf>	searchForWafByName(String name)
RestResponse<Tag>	searchTagById(String id)
RestResponse<Tag[]>	searchTagsByName(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, Boolean showInconsistentClosedDefectNeedsScan, Boolean showInconsistentClosedDefectOpenInScan, Boolean showInconsistentOpenDefect, Boolean includeCustomText)
RestResponse<Object>	setCustomCweText(String cweId, String customText)
RestResponse<String>	setCustomSeverityName(String customSeverityId, String customName)
void	setKey(String key)
void	setMemoryKey(String key)
void	setMemoryUrl(String url)
void	setOutputFilePath(String outputFilePath)
RestResponse<Application>	setParameters(String appId, String frameworkType, String repositoryUrl)
RestResponse<String>	setTaskConfig(String appId, String scannerType, String filePath)
void	setUnsafeFlag(boolean unsafeFlag)
void	setUrl(String url)
RestResponse<Object>	submitDefect(String[] paramNames, String[] paramValues, Integer appId)
RestResponse<Object>	submitDefect(String[] paramNames, String[] paramValues, Integer appId, Integer appTrackerId)
RestResponse<Object>	updateApplication(String appId, String name, String url, String uniqueId, String applicationCriticality, String frameworkType, String repositoryType, String repositoryUrl, String repositoryBranch, String repositoryUserName, String repositoryPassword, String repositoryFolder)
RestResponse<String>	updateCweEntries(String filePath)
RestResponse<Tag>	updateTag(String tagId, String name)
RestResponse<Object>	updateTeam(String teamId, String name)
RestResponse<String>	uploadCICDPolicy(String filePath)
RestResponse<Scan[]>	uploadMultiScan(String applicationId, List<String> filePaths)
RestResponse<Scan>	uploadScan(String applicationId, List<String> filePaths)
RestResponse<Scan>	uploadScan(String applicationId, String filePath)
RestResponse<Scan>	uploadSingleScan(String applicationId, String filePath)
RestResponse<Object>	uploadWafLog(String wafId, File logFile)

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<Application> createApplication(String teamId,
                                                   String name,
                                                   String url)

Specified by:

createApplication in interface ThreadFixRestClient

setParameters

public RestResponse<Application> setParameters(String appId,
                                               String frameworkType,
                                               String repositoryUrl)

Specified by:

setParameters in interface ThreadFixRestClient

createTeam

public RestResponse<Organization> createTeam(String name)

Specified by:

createTeam in interface ThreadFixRestClient

deleteTeam

public RestResponse<String> deleteTeam(String teamId)

Specified by:

deleteTeam in interface ThreadFixRestClient

updateTeam

public RestResponse<Object> updateTeam(String teamId,
                                       String name)

Specified by:

updateTeam in interface ThreadFixRestClient

getRules

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

Specified by:

getRules in interface ThreadFixRestClient

searchForWafByName

public RestResponse<Waf> searchForWafByName(String name)

Specified by:

searchForWafByName in interface ThreadFixRestClient

searchForWafById

public RestResponse<Waf> searchForWafById(String wafId)

Specified by:

searchForWafById in interface ThreadFixRestClient

getWafs

public RestResponse<Waf[]> getWafs()

Specified by:

getWafs in interface ThreadFixRestClient

uploadWafLog

public RestResponse<Object> uploadWafLog(String wafId,
                                         File logFile)

Specified by:

uploadWafLog in interface ThreadFixRestClient

createWaf

public RestResponse<Waf> createWaf(String name,
                                   String type)

Specified by:

createWaf in interface ThreadFixRestClient

addWaf

public RestResponse<Application> addWaf(String appId,
                                        String wafId)

Specified by:

addWaf in interface ThreadFixRestClient

Parameters:

appId -

wafId -

Returns:

getAllTeams

public RestResponse<Organization[]> getAllTeams()

Specified by:

getAllTeams in interface ThreadFixRestClient

getAllTeamsPrettyPrint

public RestResponse<String> getAllTeamsPrettyPrint()

Specified by:

getAllTeamsPrettyPrint in interface ThreadFixRestClient

searchForApplicationById

public RestResponse<Application> searchForApplicationById(String id)

Specified by:

searchForApplicationById in interface ThreadFixRestClient

searchForApplicationByName

public RestResponse<Application> searchForApplicationByName(String name,
                                                            String teamName)

Specified by:

searchForApplicationByName in interface ThreadFixRestClient

searchForApplicationInTeamByUniqueId

public RestResponse<Application> searchForApplicationInTeamByUniqueId(String uniqueId,
                                                                      String teamName)

Specified by:

searchForApplicationInTeamByUniqueId in interface ThreadFixRestClient

updateApplication

public RestResponse<Object> updateApplication(String appId,
                                              String name,
                                              String url,
                                              String uniqueId,
                                              String applicationCriticality,
                                              String frameworkType,
                                              String repositoryType,
                                              String repositoryUrl,
                                              String repositoryBranch,
                                              String repositoryUserName,
                                              String repositoryPassword,
                                              String repositoryFolder)

Specified by:

updateApplication in interface ThreadFixRestClient

searchForTeamById

public RestResponse<Organization> searchForTeamById(String id)

Specified by:

searchForTeamById in interface ThreadFixRestClient

searchForTeamByName

public RestResponse<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

setOutputFilePath

public void setOutputFilePath(String outputFilePath)

Specified by:

setOutputFilePath 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<Scan> uploadScan(String applicationId,
                                     List<String> filePaths)

Specified by:

uploadScan in interface ThreadFixRestClient

uploadScan

public RestResponse<Scan> uploadScan(String applicationId,
                                     String filePath)

Specified by:

uploadScan in interface ThreadFixRestClient

uploadSingleScan

public RestResponse<Scan> uploadSingleScan(String applicationId,
                                           String filePath)

Specified by:

uploadSingleScan in interface ThreadFixRestClient

uploadMultiScan

public RestResponse<Scan[]> uploadMultiScan(String applicationId,
                                            List<String> filePaths)

Specified by:

uploadMultiScan in interface ThreadFixRestClient

queueScan

public RestResponse<ScanQueueTask> queueScan(String applicationId,
                                             String scannerType)

Specified by:

queueScan in interface ThreadFixRestClient

queueScan

public RestResponse<ScanQueueTask> queueScan(String applicationId,
                                             String scannerType,
                                             String targetURL,
                                             String scanConfigId)

Specified by:

queueScan in interface ThreadFixRestClient

searchForScanById

public RestResponse<Scan> searchForScanById(String scanId)

Specified by:

searchForScanById in interface ThreadFixRestClient

getScansForApplication

public RestResponse<Scan[]> getScansForApplication(String applicationId)

Specified by:

getScansForApplication in interface ThreadFixRestClient

addAppUrl

public RestResponse<Application> addAppUrl(String appId,
                                           String url)

Specified by:

addAppUrl in interface ThreadFixRestClient

setTaskConfig

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

Specified by:

setTaskConfig in interface ThreadFixRestClient

addDynamicFinding

public RestResponse<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<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

createTag

public RestResponse<Tag> createTag(String name,
                                   String tagType)

Specified by:

createTag in interface ThreadFixRestClient

searchTagById

public RestResponse<Tag> searchTagById(String id)

Specified by:

searchTagById in interface ThreadFixRestClient

searchTagsByName

public RestResponse<Tag[]> searchTagsByName(String name)

Specified by:

searchTagsByName in interface ThreadFixRestClient

getTags

public RestResponse<Map> getTags()

Specified by:

getTags in interface ThreadFixRestClient

getAllTags

public RestResponse<Tag[]> getAllTags()

Specified by:

getAllTags in interface ThreadFixRestClient

addAppTag

public RestResponse<Application> addAppTag(String appId,
                                           String tagId)

Specified by:

addAppTag in interface ThreadFixRestClient

removeAppTag

public RestResponse<Application> removeAppTag(String appId,
                                              String tagId)

Specified by:

removeAppTag in interface ThreadFixRestClient

updateTag

public RestResponse<Tag> updateTag(String tagId,
                                   String name)

Specified by:

updateTag in interface ThreadFixRestClient

removeTag

public RestResponse<String> removeTag(String tagId)

Specified by:

removeTag 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,
                                                               Boolean showInconsistentClosedDefectNeedsScan,
                                                               Boolean showInconsistentClosedDefectOpenInScan,
                                                               Boolean showInconsistentOpenDefect,
                                                               Boolean includeCustomText)

Specified by:

searchVulnerabilities in interface ThreadFixRestClient

setUnsafeFlag

public void setUnsafeFlag(boolean unsafeFlag)

Specified by:

setUnsafeFlag in interface ThreadFixRestClient

addVulnComment

public RestResponse<String> addVulnComment(Integer vulnId,
                                           String comment,
                                           String commentTagIds)

Specified by:

addVulnComment in interface ThreadFixRestClient

submitDefect

public RestResponse<Object> submitDefect(String[] paramNames,
                                         String[] paramValues,
                                         Integer appId)

Specified by:

submitDefect in interface ThreadFixRestClient

submitDefect

public RestResponse<Object> submitDefect(String[] paramNames,
                                         String[] paramValues,
                                         Integer appId,
                                         Integer appTrackerId)

Specified by:

submitDefect in interface ThreadFixRestClient

getDefectTrackerFields

public RestResponse<DynamicFormField[]> getDefectTrackerFields(Integer appId)

Specified by:

getDefectTrackerFields in interface ThreadFixRestClient

getDefectTrackerFields

public RestResponse<DynamicFormField[]> getDefectTrackerFields(Integer appId,
                                                               Integer appTrackerId)

Specified by:

getDefectTrackerFields in interface ThreadFixRestClient

searchForApplicationsByUniqueId

public RestResponse<Application[]> searchForApplicationsByUniqueId(String uniqueId)

Specified by:

searchForApplicationsByUniqueId in interface ThreadFixRestClient

searchForApplicationsByTagId

public RestResponse<Application[]> searchForApplicationsByTagId(String tagId)

Specified by:

searchForApplicationsByTagId in interface ThreadFixRestClient

newDefectTracker

public RestResponse<DefectTracker> newDefectTracker(String defectTrackerTypeId,
                                                    String name,
                                                    String url,
                                                    String defaultUsername,
                                                    String defaultPassword,
                                                    String defaultProductName)

Specified by:

newDefectTracker in interface ThreadFixRestClient

listDefectTrackerProjects

public RestResponse<Object> listDefectTrackerProjects(String defectTrackerId)

Specified by:

listDefectTrackerProjects in interface ThreadFixRestClient

listDefectTrackerTypes

public RestResponse<Object> listDefectTrackerTypes()

Specified by:

listDefectTrackerTypes in interface ThreadFixRestClient

applicationSetDefectTracker

public RestResponse<Object> applicationSetDefectTracker(String applicationId,
                                                        String defectTrackerId,
                                                        String username,
                                                        String password,
                                                        String projectName)

Specified by:

applicationSetDefectTracker in interface ThreadFixRestClient

deletePolicy

public RestResponse<String> deletePolicy(String policyId)

Specified by:

deletePolicy in interface ThreadFixRestClient

deleteScheduledEmailReport

public RestResponse<String> deleteScheduledEmailReport(String scheduledEmailReportId)

Specified by:

deleteScheduledEmailReport in interface ThreadFixRestClient

deleteVulnerabilityFilter

public RestResponse<String> deleteVulnerabilityFilter(String vulnerabilityFilterId)

Specified by:

deleteVulnerabilityFilter in interface ThreadFixRestClient

setCustomSeverityName

public RestResponse<String> setCustomSeverityName(String customSeverityId,
                                                  String customName)

Specified by:

setCustomSeverityName in interface ThreadFixRestClient

editSeverityFilter

public RestResponse<String> editSeverityFilter(String info,
                                               String low,
                                               String medium,
                                               String high,
                                               String critical,
                                               String enabled,
                                               String appId,
                                               String teamId)

Specified by:

editSeverityFilter in interface ThreadFixRestClient

deleteScanResultFilter

public RestResponse<String> deleteScanResultFilter(String id)

Specified by:

deleteScanResultFilter in interface ThreadFixRestClient

deleteChannelFilter

public RestResponse<String> deleteChannelFilter(String id)

Specified by:

deleteChannelFilter in interface ThreadFixRestClient

setCustomCweText

public RestResponse<Object> setCustomCweText(String cweId,
                                             String customText)

Specified by:

setCustomCweText in interface ThreadFixRestClient

updateCweEntries

public RestResponse<String> updateCweEntries(String filePath)

Specified by:

updateCweEntries in interface ThreadFixRestClient

listCICDPolicies

public RestResponse<String[]> listCICDPolicies()

Specified by:

listCICDPolicies in interface ThreadFixRestClient

getCICDPolicy

public RestResponse<String> getCICDPolicy(String fileName)

Specified by:

getCICDPolicy in interface ThreadFixRestClient

uploadCICDPolicy

public RestResponse<String> uploadCICDPolicy(String filePath)

Specified by:

uploadCICDPolicy in interface ThreadFixRestClient

deleteCICDPolicy

public RestResponse<String> deleteCICDPolicy(String filePath)

Specified by:

deleteCICDPolicy in interface ThreadFixRestClient