com.checkmarx.sdk.service

Class CxService

java.lang.Object

com.checkmarx.sdk.service.CxService

All Implemented Interfaces:

CxClient

@Service
public class CxService
extends Object
implements CxClient

Class used to orchestrate submitting scans and retrieving results

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_PROCESSING_RESULTS
static String	ERROR_PROCESSING_SCAN_RESULTS
static String	ERROR_WITH_XML_REPORT
static String	REPORT_LENGTH_MESSAGE
static Integer	REPORT_STATUS_CREATED

Constructor Summary

Constructors

Constructor and Description
CxService(CxAuthClient authClient, CxProperties cxProperties, CxLegacyService cxLegacyService, org.springframework.web.client.RestTemplate restTemplate, ScanSettingsClient scanSettingsClient, FilterValidator filterValidator)

Method Summary

Modifier and Type	Method and Description
Integer	branchProject(Integer projectId, String name) Branch an existing project
void	cancelScan(Integer scanId)
Integer	createProject(String ownerId, String name) Creates a CX Project.
Integer	createScan(CxScanParams params, String comment) Create a scan based on the CxScanParams and return the scan Id
Integer	createScan(Integer projectId, boolean incremental, boolean isPublic, boolean forceScan, String comment) Create Scan for a projectId
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, FilterConfiguration 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 team based on Id
protected Map<String,Object>	getAdditionalScanDetails(CxXMLResultsType cxResults) Creates a map of additional scan details, such as scanId, scan start date, scan risk, scan risk severity, number of failed LOC, etc.
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, FilterConfiguration filters) Get the latest scan results by teamName and projectName with filtered results
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, FilterConfiguration filter) Parse CX report file, mapped to ScanResults DTO, applying filtering as requested
ScanResults	getReportContent(Integer reportId, FilterConfiguration filter) Retrieve the report by reportId, mapped to ScanResults DTO, applying filtering as requested
ScanResults	getReportContentByScanId(Integer scanId, FilterConfiguration filter) Retrieve the report by reportId, 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 by name.
String	getScanConfigurationName(int configurationId) Get scan configuration name by Id.
org.json.JSONObject	getScanData(String scanId) Fetches scan data based on given scan identifier, as a JSONObject.
Integer	getScanIdOfExistingScanIfExists(Integer projectId) Get ScanId of existing scan if a scan exists for a projectId
String	getScanSetting(Integer projectId) Get Scan Settings for an existing project.
CxScanSettings	getScanSettingsDto(int projectId)
Integer	getScanStatus(Integer scanId) Get the status of a given scanId
CxScanSummary	getScanSummary(Integer projectId) Get the scan summary for the latest scan of a given project Id
CxScanSummary	getScanSummary(String teamName, String projectName) Get the scan summary for the latest scan of a given team and project name
CxScanSummary	getScanSummaryByScanId(Integer scanId) Get scan summary for given scanId
String	getStateFullName(String key)
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
String	getTeamName(String teamId) Get fully qualified team name for a given id
List<CxTeam>	getTeams() Fetches all teams
CxXMLResultsType	getXmlReportContent(Integer reportId) Retrieve the 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	moveTeam(String teamId, String newParentTeamId) Move team to under given newParentId - Will use REST API to create team for version 9.0+
void	moveTeamWS(String teamId, String newParentTeamId) Move team under the new parentId using SOAP
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
void	renameTeam(String teamId, String newTeamName) Rename team (path is unaffected; only the actual name)
void	renameTeamWS(String teamId, String newTeamName) Rename team (path is unaffected; only the actual name) using SOAP
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	updateProjectDetails(CxProject cxProject) Update name and/or owning team for a project
void	uploadProjectSource(Integer projectId, File file) Upload file (zip of source) for a project
void	waitForScanCompletion(Integer scanId) Wait for a for a scan with a given scan Id to complete with a finished or failure state

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_STATUS_CREATED

public static final Integer REPORT_STATUS_CREATED

REPORT_LENGTH_MESSAGE

public static final String REPORT_LENGTH_MESSAGE

See Also:

Constant Field Values

ERROR_PROCESSING_RESULTS

public static final String ERROR_PROCESSING_RESULTS

See Also:

Constant Field Values

ERROR_WITH_XML_REPORT

public static final String ERROR_WITH_XML_REPORT

See Also:

Constant Field Values

ERROR_PROCESSING_SCAN_RESULTS

public static final String ERROR_PROCESSING_SCAN_RESULTS

See Also:

Constant Field Values

Constructor Detail

CxService

public CxService(CxAuthClient authClient,
                 CxProperties cxProperties,
                 CxLegacyService cxLegacyService,
                 @Qualifier(value="cxRestTemplate")
                 org.springframework.web.client.RestTemplate restTemplate,
                 ScanSettingsClient scanSettingsClient,
                 FilterValidator filterValidator)

Method Detail

createScan

public Integer createScan(Integer projectId,
                          boolean incremental,
                          boolean isPublic,
                          boolean forceScan,
                          String comment)

Create Scan for a projectId

Parameters:

projectId -

incremental -

isPublic -

forceScan -

comment -

Returns:

getLastScanId

public Integer getLastScanId(Integer projectId)

Description copied from interface: CxClient

Get the last scan Id of a given project Id

Specified by:

getLastScanId in interface CxClient

Parameters:

projectId - project Id

Returns:

getScanData

public org.json.JSONObject getScanData(String scanId)

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

Specified by:

getScanData in interface CxClient

Parameters:

scanId - scan ID to use

Returns:

populated JSONObject if scan data was fetched; empty otherwise.

getLastScanDate

public LocalDateTime getLastScanDate(Integer projectId)

Description copied from interface: CxClient

Fetches the Timestamp of the last full scan

Specified by:

getLastScanDate in interface CxClient

Returns:

getScanStatus

public Integer getScanStatus(Integer scanId)

Get the status of a given scanId

Specified by:

getScanStatus in interface CxClient

Parameters:

scanId -

Returns:

createScanReport

public Integer createScanReport(Integer scanId)

Generate a scan report request (xml) based on ScanId

Specified by:

createScanReport in interface CxClient

Returns:

getReportStatus

public Integer getReportStatus(Integer reportId)
                        throws CheckmarxException

Get the status of a report being generated by reportId

Specified by:

getReportStatus in interface CxClient

Returns:

Throws:

CheckmarxException

getReportContentByScanId

public ScanResults getReportContentByScanId(Integer scanId,
                                            FilterConfiguration filter)
                                     throws CheckmarxException

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

Specified by:

getReportContentByScanId in interface CxClient

Returns:

Throws:

CheckmarxException

getReportContent

public ScanResults getReportContent(Integer reportId,
                                    FilterConfiguration filter)
                             throws CheckmarxException

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

Specified by:

getReportContent in interface CxClient

Returns:

Throws:

CheckmarxException

getXmlReportContent

public CxXMLResultsType getXmlReportContent(Integer reportId)
                                     throws CheckmarxException

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

Specified by:

getXmlReportContent in interface CxClient

Returns:

Throws:

CheckmarxException

getAdditionalScanDetails

protected Map<String,Object> getAdditionalScanDetails(CxXMLResultsType cxResults)

Creates a map of additional scan details, such as scanId, scan start date, scan risk, scan risk severity, number of failed LOC, etc.

Parameters:

cxResults - the source to use

Returns:

a map of additional scan details

getCustomFields

public Map<String,String> getCustomFields(Integer projectId)

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

Specified by:

getCustomFields in interface CxClient

Parameters:

projectId - ID of project to lookup from Checkmarx

Returns:

Map of custom field names to values

getReportContent

public ScanResults getReportContent(File file,
                                    FilterConfiguration filter)
                             throws CheckmarxException

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

Specified by:

getReportContent in interface CxClient

Returns:

Throws:

CheckmarxException

getOsaReportContent

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

Specified by:

getOsaReportContent in interface CxClient

Returns:

Throws:

CheckmarxException

getIssueDescription

public String getIssueDescription(Long scanId,
                                  Long pathId)

Specified by:

getIssueDescription in interface CxClient

getStateFullName

public String getStateFullName(String key)

createProject

public Integer createProject(String ownerId,
                             String name)

Creates a CX Project.

Naming convention is namespace-repo-branch

Specified by:

createProject in interface CxClient

Returns:

Id of the new project

deleteProject

public void deleteProject(Integer projectId)

Description copied from interface: CxClient

Delete a project by Id

Specified by:

deleteProject in interface CxClient

branchProject

public Integer branchProject(Integer projectId,
                             String name)

Description copied from interface: CxClient

Branch an existing project

Specified by:

branchProject in interface CxClient

Parameters:

projectId - Id of the existing project to branch

name - Name for the new branched project

Returns:

Id of the new branched project, or -1 if branch request was unsuccessful

getProjects

public List<CxProject> getProjects()
                            throws CheckmarxException

Get All Projects in Checkmarx

Specified by:

getProjects in interface CxClient

Returns:

Throws:

CheckmarxException

getProjects

public List<CxProject> getProjects(String teamId)
                            throws CheckmarxException

Get All Projects in Checkmarx

Specified by:

getProjects in interface CxClient

Returns:

Throws:

CheckmarxException

getProjectId

public Integer getProjectId(String ownerId,
                            String name)

Description copied from interface: CxClient

Get All Projects under a specific team within Checkmarx

using TeamId does not work.

Specified by:

getProjectId in interface CxClient

Returns:

getProject

public CxProject getProject(Integer projectId)

Return Project based on projectId

Specified by:

getProject in interface CxClient

Returns:

scanExists

public boolean scanExists(Integer projectId)

Check if a scan exists for a projectId

Specified by:

scanExists in interface CxClient

Parameters:

projectId -

Returns:

getScanIdOfExistingScanIfExists

public Integer getScanIdOfExistingScanIfExists(Integer projectId)

Get ScanId of existing scan if a scan exists for a projectId

Specified by:

getScanIdOfExistingScanIfExists in interface CxClient

Parameters:

projectId -

Returns:

createScanSetting

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

Create Scan Settings

Specified by:

createScanSetting in interface CxClient

Returns:

Scan setting ID.

getScanSetting

public String getScanSetting(Integer projectId)

Get Scan Settings for an existing project.

Specified by:

getScanSetting in interface CxClient

Returns:

JSON string that includes preset and engine configuration info.

getScanSettingsDto

public CxScanSettings getScanSettingsDto(int projectId)

Specified by:

getScanSettingsDto in interface CxClient

getProjectPresetId

public Integer getProjectPresetId(Integer projectId)

Description copied from interface: CxClient

Get Preset Id of an existing project

Specified by:

getProjectPresetId in interface CxClient

Returns:

getPresetName

public String getPresetName(Integer presetId)

Description copied from interface: CxClient

Get Preset Name based on Id

Specified by:

getPresetName in interface CxClient

Returns:

setProjectRepositoryDetails

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

Set Repository details for a project

Specified by:

setProjectRepositoryDetails in interface CxClient

Parameters:

projectId -

gitUrl -

branch -

Throws:

CheckmarxException

updateProjectDetails

public void updateProjectDetails(CxProject cxProject)
                          throws CheckmarxException

Update name and/or owning team for a project

Specified by:

updateProjectDetails in interface CxClient

Parameters:

cxProject -

Throws:

CheckmarxException

uploadProjectSource

public void uploadProjectSource(Integer projectId,
                                File file)
                         throws CheckmarxException

Upload file (zip of source) for a project

Specified by:

uploadProjectSource in interface CxClient

Parameters:

projectId -

file -

Throws:

CheckmarxException

setProjectExcludeDetails

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

Specified by:

setProjectExcludeDetails in interface CxClient

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

getTeamId

public String getTeamId(String teamPath)
                 throws CheckmarxException

Get teamId for given path

Specified by:

getTeamId in interface CxClient

Parameters:

teamPath - Fully qualified name/path of the team to lookup

Returns:

TeamID of the team, or UNKNOWN (-1)

Throws:

CheckmarxException

getTeamName

public String getTeamName(String teamId)
                   throws CheckmarxException

Get fully qualified team name for a given id

Parameters:

teamId - TeamID to lookup

Returns:

Fully qualified team name/path

Throws:

CheckmarxException

getTeamId

public String getTeamId(String parentTeamId,
                        String teamName)
                 throws CheckmarxException

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

Specified by:

getTeamId in interface CxClient

Parameters:

parentTeamId - Parent team's TeamID

teamName - Short name of the team to lookup

Returns:

TeamID or UNKNOWN

Throws:

CheckmarxException

createTeam

public String createTeam(String parentTeamId,
                         String teamName)
                  throws CheckmarxException

Description copied from interface: CxClient

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

Specified by:

createTeam in interface CxClient

Returns:

new TeamId

Throws:

CheckmarxException

deleteTeam

public void deleteTeam(String teamId)
                throws CheckmarxException

Description copied from interface: CxClient

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

Specified by:

deleteTeam in interface CxClient

Throws:

CheckmarxException

moveTeam

public void moveTeam(String teamId,
                     String newParentTeamId)
              throws CheckmarxException

Description copied from interface: CxClient

Move team to under given newParentId - Will use REST API to create team for version 9.0+

Specified by:

moveTeam in interface CxClient

Parameters:

teamId - - Id of the team to be moved

newParentTeamId - - id of the new parent team

Throws:

CheckmarxException

renameTeam

public void renameTeam(String teamId,
                       String newTeamName)
                throws CheckmarxException

Description copied from interface: CxClient

Rename team (path is unaffected; only the actual name)

Specified by:

renameTeam in interface CxClient

Parameters:

teamId - - Id of the team to be renamed

newTeamName - - new team name

Throws:

CheckmarxException

createTeamWS

public String createTeamWS(String parentTeamId,
                           String teamName)
                    throws CheckmarxException

Create team under given parentId

Specified by:

createTeamWS in interface CxClient

Parameters:

parentTeamId -

teamName -

Returns:

Throws:

CheckmarxException

deleteTeamWS

public void deleteTeamWS(String teamId)
                  throws CheckmarxException

Delete team based on Id

Specified by:

deleteTeamWS in interface CxClient

Parameters:

teamId -

Throws:

CheckmarxException

moveTeamWS

public void moveTeamWS(String teamId,
                       String newParentTeamId)
                throws CheckmarxException

Move team under the new parentId using SOAP

Parameters:

newParentTeamId - Id of the new parent team

teamId - Id of the team to be moved

Throws:

CheckmarxException

renameTeamWS

public void renameTeamWS(String teamId,
                         String newTeamName)
                  throws CheckmarxException

Rename team (path is unaffected; only the actual name) using SOAP

Parameters:

teamId - - Id of the team to be renamed

newTeamName - - new team name

Throws:

CheckmarxException

getScanConfiguration

public Integer getScanConfiguration(String configuration)
                             throws CheckmarxException

Get scan configuration Id by name.

Specified by:

getScanConfiguration in interface CxClient

Parameters:

configuration - configuration name

Returns:

Throws:

CheckmarxException

getScanConfigurationName

public String getScanConfigurationName(int configurationId)

Description copied from interface: CxClient

Get scan configuration name by Id.

Specified by:

getScanConfigurationName in interface CxClient

getPresetId

public Integer getPresetId(String preset)
                    throws CheckmarxException

Description copied from interface: CxClient

Fetch the Id of a given preset name

Specified by:

getPresetId in interface CxClient

Parameters:

preset - name of the preset to find the Id for

Returns:

Id for the scan configuration

Throws:

CheckmarxException

getScanSummaryByScanId

public CxScanSummary getScanSummaryByScanId(Integer scanId)
                                     throws CheckmarxException

Get scan summary for given scanId

Specified by:

getScanSummaryByScanId in interface CxClient

Parameters:

scanId -

Returns:

Throws:

CheckmarxException

getScanSummary

public CxScanSummary getScanSummary(Integer projectId)
                             throws CheckmarxException

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

Specified by:

getScanSummary in interface CxClient

Parameters:

projectId - project Id to retrieve the latest scan summary for

Returns:

Throws:

CheckmarxException

getScanSummary

public CxScanSummary getScanSummary(String teamName,
                                    String projectName)
                             throws CheckmarxException

Get the scan summary for the latest scan of a given team and project name

Specified by:

getScanSummary in interface CxClient

Parameters:

teamName -

projectName -

Returns:

Throws:

CheckmarxException

createScan

public Integer createScan(CxScanParams params,
                          String comment)
                   throws CheckmarxException

Description copied from interface: CxClient

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

Specified by:

createScan in interface CxClient

Parameters:

params - attributes used to define the project

Returns:

Scan Id associated with the new scan

Throws:

CheckmarxException

createScanAndReport

public CxXMLResultsType createScanAndReport(CxScanParams params,
                                            String comment)
                                     throws CheckmarxException

Description copied from interface: CxClient

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

Specified by:

createScanAndReport in interface CxClient

Parameters:

params - attributes used to define the project

comment -

Returns:

Throws:

CheckmarxException

createScanAndReport

public ScanResults createScanAndReport(CxScanParams params,
                                       String comment,
                                       FilterConfiguration filters)
                                throws CheckmarxException

Description copied from interface: CxClient

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

Specified by:

createScanAndReport in interface CxClient

Parameters:

params - attributes used to define the project

comment -

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

Returns:

Throws:

CheckmarxException

deleteScan

public void deleteScan(Integer scanId)
                throws CheckmarxException

Specified by:

deleteScan in interface CxClient

Parameters:

scanId -

Throws:

CheckmarxException

cancelScan

public void cancelScan(Integer scanId)
                throws CheckmarxException

Specified by:

cancelScan in interface CxClient

Parameters:

scanId -

Throws:

CheckmarxException

getLatestScanReport

public CxXMLResultsType getLatestScanReport(String teamName,
                                            String projectName)
                                     throws CheckmarxException

Description copied from interface: CxClient

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

Specified by:

getLatestScanReport in interface CxClient

Parameters:

teamName -

projectName -

Returns:

Throws:

CheckmarxException

getLatestScanResults

public ScanResults getLatestScanResults(String teamName,
                                        String projectName,
                                        FilterConfiguration filters)
                                 throws CheckmarxException

Get the latest scan results by teamName and projectName with filtered results

Specified by:

getLatestScanResults in interface CxClient

Parameters:

teamName -

projectName -

filters -

Returns:

Throws:

CheckmarxException

getTeams

public List<CxTeam> getTeams()
                      throws CheckmarxException

Description copied from interface: CxClient

Fetches all teams

Specified by:

getTeams in interface CxClient

Returns:

a List containing the Teams in Checkmarx; versions prior to 9.0 return full name and ID only

Throws:

CheckmarxException

mapTeamLdap

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

Description copied from interface: CxClient

Adds an LDAP team association - uses SOAP Web Service

Specified by:

mapTeamLdap in interface CxClient

Parameters:

ldapServerId -

teamId -

teamName - not used in 9.0+

ldapGroupDn -

Throws:

CheckmarxException

getTeamLdap

public List<CxTeamLdap> getTeamLdap(Integer ldapServerId)
                             throws CheckmarxException

Description copied from interface: CxClient

Retrieve LDAP team mapping associations

Specified by:

getTeamLdap in interface CxClient

Parameters:

ldapServerId -

Returns:

Throws:

CheckmarxException

removeTeamLdap

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

Description copied from interface: CxClient

Removes an LDAP team association - uses SOAP Web Service

Specified by:

removeTeamLdap in interface CxClient

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

Throws:

CheckmarxException

getLdapTeamMapId

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

Specified by:

getLdapTeamMapId in interface CxClient

Throws:

CheckmarxException

mapTeamLdapWS

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

Description copied from interface: CxClient

Adds an LDAP team association - uses SOAP Web Service

Specified by:

mapTeamLdapWS in interface CxClient

Throws:

CheckmarxException

removeTeamLdapWS

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

Description copied from interface: CxClient

Removes an LDAP team association - uses SOAP Web Service

Specified by:

removeTeamLdapWS in interface CxClient

Throws:

CheckmarxException

getRoles

public List<CxRole> getRoles()
                      throws CheckmarxException

Description copied from interface: CxClient

Returns a list of roles in Checkmarx

Specified by:

getRoles in interface CxClient

Returns:

Throws:

CheckmarxException

getRoleLdap

public List<CxRoleLdap> getRoleLdap(Integer ldapServerId)
                             throws CheckmarxException

Description copied from interface: CxClient

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

Specified by:

getRoleLdap in interface CxClient

Parameters:

ldapServerId -

Returns:

Throws:

CheckmarxException

getRoleId

public Integer getRoleId(String roleName)
                  throws CheckmarxException

Description copied from interface: CxClient

Returns the Id of an associated role in Checkmarx

Specified by:

getRoleId in interface CxClient

Throws:

CheckmarxException

mapRoleLdap

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

Specified by:

mapRoleLdap in interface CxClient

Throws:

CheckmarxException

removeRoleLdap

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

Description copied from interface: CxClient

Removes a role/ldap mapping association

Specified by:

removeRoleLdap in interface CxClient

Throws:

CheckmarxException

removeRoleLdap

public void removeRoleLdap(Integer roleMapId)
                    throws CheckmarxException

Description copied from interface: CxClient

Removes a role/ldap mapping association

Specified by:

removeRoleLdap in interface CxClient

Throws:

CheckmarxException

getLdapRoleMapId

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

Description copied from interface: CxClient

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

Specified by:

getLdapRoleMapId in interface CxClient

Returns:

Throws:

CheckmarxException

getLdapServerId

public Integer getLdapServerId(String serverName)
                        throws CheckmarxException

Specified by:

getLdapServerId in interface CxClient

Throws:

CheckmarxException

waitForScanCompletion

public void waitForScanCompletion(Integer scanId)
                           throws CheckmarxException

Wait for a for a scan with a given scan Id to complete with a finished or failure state

Specified by:

waitForScanCompletion in interface CxClient

Parameters:

scanId -

Throws:

CheckmarxException