com.secdec.codedx.api.client

Class CodeDxClient

java.lang.Object

com.secdec.codedx.api.client.CodeDxClient

public class CodeDxClient
extends Object

A RESTful client used to access the various API end-points exposed by CodeDx.

Author:

anthonyd

Constructor Summary

Constructors

Constructor and Description
CodeDxClient(String url, String key) Creates a new client, ready to be used for communications with CodeDx.

Method Summary

Methods

Modifier and Type	Method and Description
String	buildBrowsableAnalysisRunUrl(int analysisRunId)
String	buildLatestAnalysisRunUrl(int projectId)
AnalysisRun	getAnalysisRun(int id) Retrieves a specific analysis run from CodeDx
List<AnalysisRun>	getAnalysisRuns(int id) Retrieves a list of analysis runs, for a given project, from CodeDx
int	getFindingsCount(int id, Filter filter) Retrieves the total findings count for a given run using the provided Filter
int	getFindingsCount(String id) Retrieves the total findings count for a given run.
List<CountGroup>	getFindingsGroupedCounts(int id, Filter filter, String countBy) Retrieves an array of CountGroups using the provided Filter and countBy field name.
Job	getJob(String id) Retrieves a specific job from CodeDx
String	getJobStatus(String id) Retrieves a job status from CodeDx.
Project	getProject(int id) Retrieves a specific project from CodeDx
List<Project>	getProjects() Retrieves a list of projects from CodeDx.
Map<String,TriageStatus>	getTriageStatuses(int id) Retrieves all Triage statuses for a given project.
StartAnalysisResponse	startAnalysis(int projectId, InputStream[] artifacts) Kicks off a CodeDx analysis run on a specified project

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeDxClient

public CodeDxClient(String url,
            String key)

Creates a new client, ready to be used for communications with CodeDx.

Parameters:

url - URL of the CodeDx web application. The '/api' part of the URL is optional.

key - The API key. Note that permissions must be set for this key on CodeDx admin page.

Method Detail

buildBrowsableAnalysisRunUrl

public String buildBrowsableAnalysisRunUrl(int analysisRunId)

buildLatestAnalysisRunUrl

public String buildLatestAnalysisRunUrl(int projectId)

getProjects

public List<Project> getProjects()
                          throws CodeDxClientException,
                                 org.apache.http.client.ClientProtocolException,
                                 IOException

Retrieves a list of projects from CodeDx.

Returns:

Project list

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

getProject

public Project getProject(int id)
                   throws CodeDxClientException,
                          org.apache.http.client.ClientProtocolException,
                          IOException

Retrieves a specific project from CodeDx

Parameters:

id - The project ID

Returns:

A project

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

getTriageStatuses

public Map<String,TriageStatus> getTriageStatuses(int id)
                                           throws CodeDxClientException,
                                                  org.apache.http.client.ClientProtocolException,
                                                  IOException

Retrieves all Triage statuses for a given project.

Parameters:

id - The project ID

Returns:

A map from status code String to TriageStatus

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

getAnalysisRun

public AnalysisRun getAnalysisRun(int id)
                           throws CodeDxClientException,
                                  org.apache.http.client.ClientProtocolException,
                                  IOException

Retrieves a specific analysis run from CodeDx

Parameters:

id - The run ID

Returns:

An AnalysisRun

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

getAnalysisRuns

public List<AnalysisRun> getAnalysisRuns(int id)
                                  throws CodeDxClientException,
                                         org.apache.http.client.ClientProtocolException,
                                         IOException

Retrieves a list of analysis runs, for a given project, from CodeDx

Parameters:

id - The project ID

Returns:

A list of AnalysisRuns

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

getJob

public Job getJob(String id)
           throws CodeDxClientException,
                  org.apache.http.client.ClientProtocolException,
                  IOException

Retrieves a specific job from CodeDx

Parameters:

id - The job ID

Returns:

A Job

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

getJobStatus

public String getJobStatus(String id)
                    throws CodeDxClientException,
                           org.apache.http.client.ClientProtocolException,
                           IOException

Retrieves a job status from CodeDx. This is a convenience method for polling that relies on getJob.

Parameters:

id - The job ID

Returns:

The Job Status

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

getFindingsCount

public int getFindingsCount(String id)
                     throws CodeDxClientException,
                            org.apache.http.client.ClientProtocolException,
                            IOException

Retrieves the total findings count for a given run.

Parameters:

id - The run ID

Returns:

The count

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

getFindingsCount

public int getFindingsCount(int id,
                   Filter filter)
                     throws CodeDxClientException,
                            org.apache.http.client.ClientProtocolException,
                            IOException

Retrieves the total findings count for a given run using the provided Filter

Parameters:

id - The run ID

filter - A Filter object (set to null to not filter)

Returns:

The count

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

getFindingsGroupedCounts

public List<CountGroup> getFindingsGroupedCounts(int id,
                                        Filter filter,
                                        String countBy)
                                          throws CodeDxClientException,
                                                 org.apache.http.client.ClientProtocolException,
                                                 IOException

Retrieves an array of CountGroups using the provided Filter and countBy field name.

Parameters:

id - The run ID

filter - A Filter object

countBy - The field to group the counts by

Returns:

A list of CountGroups

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

startAnalysis

public StartAnalysisResponse startAnalysis(int projectId,
                                  InputStream[] artifacts)
                                    throws org.apache.http.client.ClientProtocolException,
                                           IOException,
                                           CodeDxClientException

Kicks off a CodeDx analysis run on a specified project

Parameters:

projectId - The project ID

artifacts - An array of streams to send over as analysis artifacts

Returns:

A StartAnalysisResponse object

Throws:

org.apache.http.client.ClientProtocolException

IOException

CodeDxClientException