com.checkmarx.sdk.service

Interface CxClient

All Known Implementing Classes:

CxService

public interface CxClient

Class used to orchestrate submitting scans and retrieving results

Method Summary

Modifier and Type	Method and Description
Integer	createProject(String ownerId, String name) Create Project under a given Owner Id team
Integer	createScan(CxScanParams params, String comment) Create a scan based on the CxScanParams and return the scan Id
CxXMLResultsType	createScanAndReport(CxScanParams params, String comment) Create a scan based on the CxScanParams and wait for the scan to complete, returning the result XML Jaxb object
ScanResults	createScanAndReport(CxScanParams params, String comment, List<Filter> filters) Create a scan based on the CxScanParams and return the ScanResults object based on filters
Integer	createScanReport(Integer scanId) Generate a scan report request (xml) based on ScanId
Integer	createScanSetting(Integer projectId, Integer presetId, Integer engineConfigId) Create Scan Settings
String	createTeam(String parentTeamId, String teamName) Create team under given parentId - Will use REST API to create team for version 9.0+
String	createTeamWS(String parentTeamId, String teamName) Create team under given parentId
void	deleteProject(Integer projectId) Delete a project by Id
void	deleteScan(Integer scanId)
void	deleteTeam(String teamId) Create team under given parentId - Will use REST API to create team for version 9.0+
void	deleteTeamWS(String teamId) Delete a team based on the name for a given parent team id
Map<String,String>	getCustomFields(Integer projectId) Returns custom field values read from a Checkmarx project, based on given projectId.
String	getIssueDescription(Long scanId, Long pathId)
LocalDateTime	getLastScanDate(Integer projectId) Fetches the Timestamp of the last full scan
Integer	getLastScanId(Integer projectId) Get the last scan Id of a given project Id
CxXMLResultsType	getLatestScanReport(String teamName, String projectName) Create a scan based on the CxScanParams and wait for the scan to complete, returning the result XML Jaxb object
ScanResults	getLatestScanResults(String teamName, String projectName, List<Filter> filters) Create a scan based on the CxScanParams and return the ScanResults object based on filters
Integer	getLdapRoleMapId(Integer ldapServerId, Integer roleId, String ldapGroupDn) Retrieve the Id of a role mapping associated with an LDAP Group DN
Integer	getLdapServerId(String serverName)
Integer	getLdapTeamMapId(Integer ldapServerId, String teamId, String ldapGroupDn)
ScanResults	getOsaReportContent(File vulnsFile, File libsFile, List<Filter> filter)
Integer	getPresetId(String preset) Fetch the Id of a given preset name
String	getPresetName(Integer presetId) Get Preset Name based on Id
CxProject	getProject(Integer projectId) Return Project based on projectId
Integer	getProjectId(String ownerId, String name) Get All Projects under a specific team within Checkmarx
Integer	getProjectPresetId(Integer projectId) Get Preset Id of an existing project
List<CxProject>	getProjects() Get All Projects in Checkmarx
List<CxProject>	getProjects(String teamId) Get All Projects in Checkmarx
ScanResults	getReportContent(File file, List<Filter> filter) Parse CX report file, mapped to ScanResults DTO, applying filtering as requested
ScanResults	getReportContent(Integer reportId, List<Filter> filter) Retrieve the report by reportId, mapped to ScanResults DTO, applying filtering as requested
ScanResults	getReportContentByScanId(Integer scanId, List<Filter> filter) Retrieve the report by scanId, mapped to ScanResults DTO, applying filtering as requested
Integer	getReportStatus(Integer reportId) Get the status of a report being generated by reportId
Integer	getRoleId(String roleName) Returns the Id of an associated role in Checkmarx
List<CxRoleLdap>	getRoleLdap(Integer ldapServerId) Retrieve list of Role LDAP mappings associated with an LDAP server Id
List<CxRole>	getRoles() Returns a list of roles in Checkmarx
Integer	getScanConfiguration(String configuration) Get scan configuration Id
org.json.JSONObject	getScanData(String scanId) Fetches scan data based on given scan identifier, as a JSONObject.
String	getScanSetting(Integer projectId) Get Scan Settings for an existing project (JSON String)
Integer	getScanStatus(Integer scanId) Get the status of a given scanId
CxScanSummary	getScanSummary(Integer projectId) Get scan summary for the latest scan of a given project Id
CxScanSummary	getScanSummary(String teamName, String projectName) Get scan summary for the latest scan associated with a teamName & projectName
CxScanSummary	getScanSummaryByScanId(Integer scanId) Get scan summary for given scanId
String	getTeamId(String teamPath) Get teamId for given path
String	getTeamId(String parentTeamId, String teamName) Get a team Id based on the name and the Parent Team Id
List<CxTeamLdap>	getTeamLdap(Integer ldapServerId) Retrieve LDAP team mapping associations
List<CxTeam>	getTeams() Fetches all teams
CxXMLResultsType	getXmlReportContent(Integer reportId) Retrieve the xml report by reportId, mapped to ScanResults DTO, applying filtering as requested
void	mapRoleLdap(Integer ldapServerId, Integer roleId, String ldapGroupDn)
void	mapTeamLdap(Integer ldapServerId, String teamId, String teamName, String ldapGroupDn) Adds an LDAP team association - uses SOAP Web Service
void	mapTeamLdapWS(Integer ldapServerId, String teamId, String teamName, String ldapGroupDn) Adds an LDAP team association - uses SOAP Web Service
void	removeRoleLdap(Integer roleMapId) Removes a role/ldap mapping association
void	removeRoleLdap(Integer ldapServerId, Integer roleId, String ldapGroupDn) Removes a role/ldap mapping association
void	removeTeamLdap(Integer ldapServerId, String teamId, String teamName, String ldapGroupDn) Removes an LDAP team association - uses SOAP Web Service
void	removeTeamLdapWS(Integer ldapServerId, String teamId, String teamName, String ldapGroupDn) Removes an LDAP team association - uses SOAP Web Service
boolean	scanExists(Integer projectId) Check if a scan exists for a projectId
void	setProjectExcludeDetails(Integer projectId, List<String> excludeFolders, List<String> excludeFiles)
void	setProjectRepositoryDetails(Integer projectId, String gitUrl, String branch) Set Repository details for a project
void	uploadProjectSource(Integer projectId, File file) Upload file (zip of source) for a project
void	waitForScanCompletion(Integer scanId) Wait for the scan of a given scan Id to finish

Method Detail

getLastScanId

Integer getLastScanId(Integer projectId)

Get the last scan Id of a given project Id

Parameters:

projectId - project Id

Returns:

getScanData

org.json.JSONObject getScanData(String scanId)

Fetches scan data based on given scan identifier, as a JSONObject.

Parameters:

scanId - scan ID to use

Returns:

populated JSONObject if scan data was fetched; empty otherwise.

getLastScanDate

LocalDateTime getLastScanDate(Integer projectId)

Fetches the Timestamp of the last full scan

Parameters:

projectId -

Returns:

getScanStatus

Integer getScanStatus(Integer scanId)

Get the status of a given scanId

Parameters:

scanId -

Returns:

createScanReport

Integer createScanReport(Integer scanId)

Generate a scan report request (xml) based on ScanId

Parameters:

scanId -

Returns:

getReportStatus

Integer getReportStatus(Integer reportId)
                 throws CheckmarxException

Get the status of a report being generated by reportId

Parameters:

reportId -

Returns:

Throws:

CheckmarxException

getReportContentByScanId

ScanResults getReportContentByScanId(Integer scanId,
                                     List<Filter> filter)
                              throws CheckmarxException

Retrieve the report by scanId, mapped to ScanResults DTO, applying filtering as requested

Parameters:

scanId -

filter -

Returns:

Throws:

CheckmarxException

getReportContent

ScanResults getReportContent(Integer reportId,
                             List<Filter> filter)
                      throws CheckmarxException

Retrieve the report by reportId, mapped to ScanResults DTO, applying filtering as requested

Parameters:

reportId -

filter -

Returns:

Throws:

CheckmarxException

getXmlReportContent

CxXMLResultsType getXmlReportContent(Integer reportId)
                              throws CheckmarxException

Retrieve the xml report by reportId, mapped to ScanResults DTO, applying filtering as requested

Parameters:

reportId -

Returns:

Throws:

CheckmarxException

getCustomFields

Map<String,String> getCustomFields(Integer projectId)

Returns custom field values read from a Checkmarx project, based on given projectId.

Parameters:

projectId - ID of project to lookup from Checkmarx

Returns:

Map of custom field names to values

getReportContent

ScanResults getReportContent(File file,
                             List<Filter> filter)
                      throws CheckmarxException

Parse CX report file, mapped to ScanResults DTO, applying filtering as requested

Parameters:

file -

filter -

Returns:

Throws:

CheckmarxException

getOsaReportContent

ScanResults getOsaReportContent(File vulnsFile,
                                File libsFile,
                                List<Filter> filter)
                         throws CheckmarxException

Parameters:

vulnsFile -

libsFile -

filter -

Returns:

Throws:

CheckmarxException

getIssueDescription

String getIssueDescription(Long scanId,
                           Long pathId)

createProject

Integer createProject(String ownerId,
                      String name)

Create Project under a given Owner Id team

Parameters:

ownerId -

name -

Returns:

Id of the new project

deleteProject

void deleteProject(Integer projectId)

Delete a project by Id

Parameters:

projectId -

getProjects

List<CxProject> getProjects()
                     throws CheckmarxException

Get All Projects in Checkmarx

Returns:

Throws:

CheckmarxException

getProjects

List<CxProject> getProjects(String teamId)
                     throws CheckmarxException

Get All Projects in Checkmarx

Returns:

Throws:

CheckmarxException

getProjectId

Integer getProjectId(String ownerId,
                     String name)

Get All Projects under a specific team within Checkmarx

using TeamId does not work.

Parameters:

ownerId -

Returns:

getProject

CxProject getProject(Integer projectId)

Return Project based on projectId

Returns:

scanExists

boolean scanExists(Integer projectId)

Check if a scan exists for a projectId

Parameters:

projectId -

Returns:

createScanSetting

Integer createScanSetting(Integer projectId,
                          Integer presetId,
                          Integer engineConfigId)

Create Scan Settings

Parameters:

projectId -

presetId -

engineConfigId -

Returns:

getScanSetting

String getScanSetting(Integer projectId)

Get Scan Settings for an existing project (JSON String)

Parameters:

projectId -

Returns:

getPresetName

String getPresetName(Integer presetId)

Get Preset Name based on Id

Parameters:

presetId -

Returns:

getProjectPresetId

Integer getProjectPresetId(Integer projectId)

Get Preset Id of an existing project

Parameters:

projectId -

Returns:

setProjectRepositoryDetails

void setProjectRepositoryDetails(Integer projectId,
                                 String gitUrl,
                                 String branch)
                          throws CheckmarxException

Set Repository details for a project

Parameters:

projectId -

gitUrl -

branch -

Throws:

CheckmarxException

uploadProjectSource

void uploadProjectSource(Integer projectId,
                         File file)
                  throws CheckmarxException

Upload file (zip of source) for a project

Parameters:

projectId -

file -

Throws:

CheckmarxException

setProjectExcludeDetails

void setProjectExcludeDetails(Integer projectId,
                              List<String> excludeFolders,
                              List<String> excludeFiles)

Parameters:

projectId - Id of Checkmarx Project

excludeFolders - list of folder exclusions to apply to a scan

excludeFiles - list of file exclusions to apply to a scan

getLdapTeamMapId

Integer getLdapTeamMapId(Integer ldapServerId,
                         String teamId,
                         String ldapGroupDn)
                  throws CheckmarxException

Parameters:

ldapServerId -

ldapGroupDn -

Throws:

CheckmarxException

getTeamId

String getTeamId(String teamPath)
          throws CheckmarxException

Get teamId for given path

Parameters:

teamPath -

Returns:

Throws:

CheckmarxException

getTeams

List<CxTeam> getTeams()
               throws CheckmarxException

Fetches all teams

Returns:

a List containing the Teams in Checkmarx

Throws:

CheckmarxException

mapTeamLdap

void mapTeamLdap(Integer ldapServerId,
                 String teamId,
                 String teamName,
                 String ldapGroupDn)
          throws CheckmarxException

Adds an LDAP team association - uses SOAP Web Service

Parameters:

ldapServerId -

teamId -

teamName -

ldapGroupDn -

Throws:

CheckmarxException

getTeamLdap

List<CxTeamLdap> getTeamLdap(Integer ldapServerId)
                      throws CheckmarxException

Retrieve LDAP team mapping associations

Parameters:

ldapServerId -

Throws:

CheckmarxException

removeTeamLdap

void removeTeamLdap(Integer ldapServerId,
                    String teamId,
                    String teamName,
                    String ldapGroupDn)
             throws CheckmarxException

Removes an LDAP team association - uses SOAP Web Service

Parameters:

ldapServerId -

teamId -

teamName - can be null/empty if using 9.0. Only applicable to 8.x

ldapGroupDn -

Throws:

CheckmarxException

getRoles

List<CxRole> getRoles()
               throws CheckmarxException

Returns a list of roles in Checkmarx

Returns:

Throws:

CheckmarxException

getRoleId

Integer getRoleId(String roleName)
           throws CheckmarxException

Returns the Id of an associated role in Checkmarx

Parameters:

roleName -

Throws:

CheckmarxException

getRoleLdap

List<CxRoleLdap> getRoleLdap(Integer ldapServerId)
                      throws CheckmarxException

Retrieve list of Role LDAP mappings associated with an LDAP server Id

Parameters:

ldapServerId -

Returns:

Throws:

CheckmarxException

getLdapRoleMapId

Integer getLdapRoleMapId(Integer ldapServerId,
                         Integer roleId,
                         String ldapGroupDn)
                  throws CheckmarxException

Retrieve the Id of a role mapping associated with an LDAP Group DN

Parameters:

ldapServerId -

ldapGroupDn -

Returns:

Throws:

CheckmarxException

mapRoleLdap

void mapRoleLdap(Integer ldapServerId,
                 Integer roleId,
                 String ldapGroupDn)
          throws CheckmarxException

Parameters:

ldapServerId -

roleId -

ldapGroupDn -

Throws:

CheckmarxException

removeRoleLdap

void removeRoleLdap(Integer roleMapId)
             throws CheckmarxException

Removes a role/ldap mapping association

Parameters:

roleMapId -

Throws:

CheckmarxException

removeRoleLdap

void removeRoleLdap(Integer ldapServerId,
                    Integer roleId,
                    String ldapGroupDn)
             throws CheckmarxException

Removes a role/ldap mapping association

Parameters:

ldapServerId -

roleId -

ldapGroupDn -

Throws:

CheckmarxException

mapTeamLdapWS

void mapTeamLdapWS(Integer ldapServerId,
                   String teamId,
                   String teamName,
                   String ldapGroupDn)
            throws CheckmarxException

Adds an LDAP team association - uses SOAP Web Service

Parameters:

ldapServerId -

teamId -

teamName -

ldapGroupDn -

Throws:

CheckmarxException

removeTeamLdapWS

void removeTeamLdapWS(Integer ldapServerId,
                      String teamId,
                      String teamName,
                      String ldapGroupDn)
               throws CheckmarxException

Removes an LDAP team association - uses SOAP Web Service

Parameters:

ldapServerId -

teamId -

teamName -

ldapGroupDn -

Throws:

CheckmarxException

createTeamWS

String createTeamWS(String parentTeamId,
                    String teamName)
             throws CheckmarxException

Create team under given parentId

Parameters:

parentTeamId -

teamName -

Returns:

new TeamId

Throws:

CheckmarxException

createTeam

String createTeam(String parentTeamId,
                  String teamName)
           throws CheckmarxException

Create team under given parentId - Will use REST API to create team for version 9.0+

Parameters:

parentTeamId -

teamName -

Returns:

new TeamId

Throws:

CheckmarxException

deleteTeam

void deleteTeam(String teamId)
         throws CheckmarxException

Create team under given parentId - Will use REST API to create team for version 9.0+

Parameters:

teamId -

Throws:

CheckmarxException

getTeamId

String getTeamId(String parentTeamId,
                 String teamName)
          throws CheckmarxException

Get a team Id based on the name and the Parent Team Id

Parameters:

parentTeamId -

teamName -

Returns:

Throws:

CheckmarxException

deleteTeamWS

void deleteTeamWS(String teamId)
           throws CheckmarxException

Delete a team based on the name for a given parent team id

Parameters:

teamId -

Throws:

CheckmarxException

getScanConfiguration

Integer getScanConfiguration(String configuration)
                      throws CheckmarxException

Get scan configuration Id

Parameters:

configuration -

Returns:

Throws:

CheckmarxException

getPresetId

Integer getPresetId(String preset)
             throws CheckmarxException

Fetch the Id of a given preset name

Parameters:

preset - name of the preset to find the Id for

Returns:

Id for the scan configuration

Throws:

CheckmarxException

getScanSummaryByScanId

CxScanSummary getScanSummaryByScanId(Integer scanId)
                              throws CheckmarxException

Get scan summary for given scanId

Parameters:

scanId -

Returns:

Id for the preset

Throws:

CheckmarxException

getScanSummary

CxScanSummary getScanSummary(Integer projectId)
                      throws CheckmarxException

Get scan summary for the latest scan of a given project Id

Parameters:

projectId - project Id to retrieve the latest scan summary for

Returns:

CxScanSummary containing scan summary information

Throws:

CheckmarxException

getScanSummary

CxScanSummary getScanSummary(String teamName,
                             String projectName)
                      throws CheckmarxException

Get scan summary for the latest scan associated with a teamName & projectName

Parameters:

teamName -

projectName -

Returns:

CxScanSummary containing scan summary information

Throws:

CheckmarxException

createScan

Integer createScan(CxScanParams params,
                   String comment)
            throws CheckmarxException

Create a scan based on the CxScanParams and return the scan Id

Parameters:

params - attributes used to define the project

comment -

Returns:

Scan Id associated with the new scan

Throws:

CheckmarxException

waitForScanCompletion

void waitForScanCompletion(Integer scanId)
                    throws CheckmarxException

Wait for the scan of a given scan Id to finish

Parameters:

scanId -

Throws:

CheckmarxException

deleteScan

void deleteScan(Integer scanId)
         throws CheckmarxException

Parameters:

scanId -

Throws:

CheckmarxException

createScanAndReport

CxXMLResultsType createScanAndReport(CxScanParams params,
                                     String comment)
                              throws CheckmarxException

Create a scan based on the CxScanParams and wait for the scan to complete, returning the result XML Jaxb object

Parameters:

params - attributes used to define the project

comment -

Returns:

CxXMLResultType (Jaxb/XML object representation of the scan results)

Throws:

CheckmarxException

createScanAndReport

ScanResults createScanAndReport(CxScanParams params,
                                String comment,
                                List<Filter> filters)
                         throws CheckmarxException

Create a scan based on the CxScanParams and return the ScanResults object based on filters

Parameters:

params - attributes used to define the project

comment -

filters - filters to apply to the scan result set (severity, category, cwe)

Returns:

Throws:

CheckmarxException

getLatestScanReport

CxXMLResultsType getLatestScanReport(String teamName,
                                     String projectName)
                              throws CheckmarxException

Create a scan based on the CxScanParams and wait for the scan to complete, returning the result XML Jaxb object

Parameters:

teamName -

projectName -

Returns:

Throws:

CheckmarxException

getLatestScanResults

ScanResults getLatestScanResults(String teamName,
                                 String projectName,
                                 List<Filter> filters)
                          throws CheckmarxException

Create a scan based on the CxScanParams and return the ScanResults object based on filters

Parameters:

teamName -

projectName -

filters -

Returns:

Throws:

CheckmarxException

getLdapServerId

Integer getLdapServerId(String serverName)
                 throws CheckmarxException

Throws:

CheckmarxException