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<com.denimgroup.threadfix.data.entities.Application>	addAppTag(String appId, String tagId)
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<String>	addVulnComment(Integer vulnId, String comment, String commentTagIds)
RestResponse<com.denimgroup.threadfix.data.entities.Application>	addWaf(String appId, String wafId)
RestResponse<com.denimgroup.threadfix.data.entities.Application>	createApplication(String teamId, String name, String url)
RestResponse<com.denimgroup.threadfix.data.entities.Tag>	createTag(String name, String tagType)
RestResponse<com.denimgroup.threadfix.data.entities.Organization>	createTeam(String name)
RestResponse<com.denimgroup.threadfix.data.entities.Waf>	createWaf(String name, String type)
RestResponse<Map>	getAllTags()
RestResponse<com.denimgroup.threadfix.data.entities.Organization[]>	getAllTeams()
RestResponse<String>	getAllTeamsPrettyPrint()
RestResponse<com.denimgroup.threadfix.viewmodels.DynamicFormField[]>	getDefectTrackerFields(Integer appId)
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.ScanQueueTask>	queueScan(String applicationId, String scannerType, String scanConfigId)
RestResponse<com.denimgroup.threadfix.data.entities.Application>	removeAppTag(String appId, String tagId)
RestResponse<String>	removeTag(String tagId)
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>	searchForApplicationInTeamByUniqueId(String uniqueId, String teamName)
RestResponse<com.denimgroup.threadfix.data.entities.Application[]>	searchForApplicationsByTagId(String tagId)
RestResponse<com.denimgroup.threadfix.data.entities.Application[]>	searchForApplicationsByUniqueId(String uniqueId)
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<com.denimgroup.threadfix.data.entities.Tag>	searchTagById(String id)
RestResponse<com.denimgroup.threadfix.data.entities.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)
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	setUnsafeFlag(boolean unsafeFlag)
void	setUrl(String url)
RestResponse<Object>	submitDefect(String[] paramNames, String[] paramValues, Integer appId)
RestResponse<com.denimgroup.threadfix.data.entities.Tag>	updateTag(String tagId, String name)
RestResponse<com.denimgroup.threadfix.data.entities.Scan>	uploadScan(String applicationId, String filePath)

Method Detail

getRules

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

searchForWafByName

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

searchForWafById

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

createWaf

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

addWaf

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

createApplication

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

setParameters

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

searchForApplicationById

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

searchForApplicationByName

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

searchForApplicationInTeamByUniqueId

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

getAllTeams

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

createTeam

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

getAllTeamsPrettyPrint

RestResponse<String> getAllTeamsPrettyPrint()

searchForTeamById

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

searchForTeamByName

RestResponse<com.denimgroup.threadfix.data.entities.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)

setKey

void setKey(String key)

setUrl

void setUrl(String url)

setMemoryKey

void setMemoryKey(String key)

setMemoryUrl

void setMemoryUrl(String url)

uploadScan

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

addAppUrl

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

queueScan

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

queueScan

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

setTaskConfig

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

addDynamicFinding

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

addStaticFinding

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)

createTag

RestResponse<com.denimgroup.threadfix.data.entities.Tag> createTag(String name,
                                                                   String tagType)

searchTagById

RestResponse<com.denimgroup.threadfix.data.entities.Tag> searchTagById(String id)

searchTagsByName

RestResponse<com.denimgroup.threadfix.data.entities.Tag[]> searchTagsByName(String name)

getAllTags

RestResponse<Map> getAllTags()

addAppTag

RestResponse<com.denimgroup.threadfix.data.entities.Application> addAppTag(String appId,
                                                                           String tagId)

removeAppTag

RestResponse<com.denimgroup.threadfix.data.entities.Application> removeAppTag(String appId,
                                                                              String tagId)

updateTag

RestResponse<com.denimgroup.threadfix.data.entities.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)

getDefectTrackerFields

RestResponse<com.denimgroup.threadfix.viewmodels.DynamicFormField[]> getDefectTrackerFields(Integer appId)

searchForApplicationsByUniqueId

RestResponse<com.denimgroup.threadfix.data.entities.Application[]> searchForApplicationsByUniqueId(String uniqueId)

searchForApplicationsByTagId

RestResponse<com.denimgroup.threadfix.data.entities.Application[]> searchForApplicationsByTagId(String tagId)