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
Project	getProject(int id) Retreives a specific project from CodeDx
List<Project>	getProjects() Retrieves a list of projects from CodeDx.
void	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

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

Retreives a specific project from CodeDx

Parameters:

id - The project ID

Returns:

A project

Throws:

CodeDxClientException

org.apache.http.client.ClientProtocolException

IOException

startAnalysis

public void 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

Throws:

org.apache.http.client.ClientProtocolException

IOException

CodeDxClientException