com.denimgroup.threadfix.remote

Interface ThreadFixRestClient

All Known Implementing Classes:

ThreadFixRestClientImpl

public interface ThreadFixRestClient

Created with IntelliJ IDEA. User: stran Date: 11/19/13 Time: 3:27 PM To change this template use File | Settings | File Templates.

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 teamId, String appId)
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)

Method Detail

getRules

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

searchForWafByName

RestResponse<Waf> searchForWafByName(String name)

searchForWafById

RestResponse<Waf> searchForWafById(String wafId)

createWaf

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

getWafs

RestResponse<Waf[]> getWafs()

uploadWafLog

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

addWaf

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

createApplication

RestResponse<Application> createApplication(String teamId,
                                            String name,
                                            String url)

setParameters

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

searchForApplicationById

RestResponse<Application> searchForApplicationById(String id)

searchForApplicationByName

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

searchForApplicationInTeamByUniqueId

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

updateApplication

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)

getAllTeams

RestResponse<Organization[]> getAllTeams()

createTeam

RestResponse<Organization> createTeam(String name)

deleteTeam

RestResponse<String> deleteTeam(String teamId)

updateTeam

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

getAllTeamsPrettyPrint

RestResponse<String> getAllTeamsPrettyPrint()

searchForTeamById

RestResponse<Organization> searchForTeamById(String id)

searchForTeamByName

RestResponse<Organization> searchForTeamByName(String name)

searchVulnerabilities

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)

setKey

void setKey(String key)

setUrl

void setUrl(String url)

setOutputFilePath

void setOutputFilePath(String outputFilePath)

setMemoryKey

void setMemoryKey(String key)

setMemoryUrl

void setMemoryUrl(String url)

uploadScan

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

uploadScan

RestResponse<Scan> uploadScan(String applicationId,
                              List<String> filePaths)

uploadSingleScan

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

uploadMultiScan

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

searchForScanById

RestResponse<Scan> searchForScanById(String scanId)

addAppUrl

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

queueScan

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

queueScan

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

getScansForApplication

RestResponse<Scan[]> getScansForApplication(String applicationId)

setTaskConfig

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

addDynamicFinding

RestResponse<Finding> addDynamicFinding(String applicationId,
                                        String vulnType,
                                        String severity,
                                        String nativeId,
                                        String parameter,
                                        String longDescription,
                                        String fullUrl,
                                        String path)

addStaticFinding

RestResponse<Finding> addStaticFinding(String applicationId,
                                       String vulnType,
                                       String severity,
                                       String nativeId,
                                       String parameter,
                                       String longDescription,
                                       String filePath,
                                       String column,
                                       String lineText,
                                       String lineNumber)

createTag

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

searchTagById

RestResponse<Tag> searchTagById(String id)

searchTagsByName

RestResponse<Tag[]> searchTagsByName(String name)

getTags

RestResponse<Map> getTags()

getAllTags

RestResponse<Tag[]> getAllTags()

addAppTag

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

removeAppTag

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

updateTag

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

removeTag

RestResponse<String> removeTag(String tagId)

setUnsafeFlag

void setUnsafeFlag(boolean unsafeFlag)

addVulnComment

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

submitDefect

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

submitDefect

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

getDefectTrackerFields

RestResponse<DynamicFormField[]> getDefectTrackerFields(Integer appId)

getDefectTrackerFields

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

searchForApplicationsByUniqueId

RestResponse<Application[]> searchForApplicationsByUniqueId(String uniqueId)

searchForApplicationsByTagId

RestResponse<Application[]> searchForApplicationsByTagId(String tagId)

newDefectTracker

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

listDefectTrackerProjects

RestResponse<Object> listDefectTrackerProjects(String defectTrackerId)

listDefectTrackerTypes

RestResponse<Object> listDefectTrackerTypes()

applicationSetDefectTracker

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

deletePolicy

RestResponse<String> deletePolicy(String policyId)

deleteScheduledEmailReport

RestResponse<String> deleteScheduledEmailReport(String scheduledEmailReportId)

deleteVulnerabilityFilter

RestResponse<String> deleteVulnerabilityFilter(String vulnerabilityFilterId)

setCustomSeverityName

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

editSeverityFilter

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

deleteScanResultFilter

RestResponse<String> deleteScanResultFilter(String id)

deleteChannelFilter

RestResponse<String> deleteChannelFilter(String id)

setCustomCweText

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

updateCweEntries

RestResponse<String> updateCweEntries(String filePath)

listCICDPolicies

RestResponse<String[]> listCICDPolicies()

getCICDPolicy

RestResponse<String> getCICDPolicy(String fileName)

uploadCICDPolicy

RestResponse<String> uploadCICDPolicy(String filePath)

deleteCICDPolicy

RestResponse<String> deleteCICDPolicy(String filePath)