org.jenkinsci.plugins.fod

Class FoDAPI

java.lang.Object

org.jenkinsci.plugins.fod.FoDAPI

public class FoDAPI
extends Object

Author:

Kevin.Williams, Michael.A.Marshall, ryancblack

Constructor Summary

Constructors

Constructor and Description
FoDAPI()

Method Summary

Modifier and Type	Method and Description
boolean	authorize() Authenticates against FoD API and caches session token.
boolean	authorize(String clientId, String clientSecret) Authenticates against FoD API and caches session token.
protected StringBuffer	collectInputStream(InputStream is)
String	encodeURLParamUTF8(String param)
Map<String,String>	getApplicationList()
Map<String,String>	getAssessmentTypeListWithRetry()
String	getBaseUrl()
protected com.google.gson.JsonArray	getDataJsonArray(StringBuffer response)
protected com.google.gson.JsonElement	getDataJsonElement(String responseString)
protected com.google.gson.Gson	getGson()
protected HttpURLConnection	getHttpUrlConnection(String requestMethod, URL url)
Proxy	getProxy()
Release	getRelease(Long releaseId)
Release	getRelease(String applicationName, String releaseName) Retrieves release info base on application name and release name.
Long	getReleaseId(String applicationName, String releaseName)
List<Release>	getReleaseList() Retrieves all releases for the tenant, with a limited number of fields populated.
List<Release>	getReleaseList(Long applicationId) Retrieves all releases for a given application name, with a limited number of fields populated.
List<Release>	getReleaseList(String applicationName) Retrieves all releases for a given application name, with a limited number of fields populated.
Scan	getScan(Long releaseId, Long scanId) Retrieves information on a single scan, given a release and scan ID.
List<ScanSnapshot>	getScanSnapshotList() Scan snapshot refers to a particular point in history when statistics are reevaluated, such as when a scan is completed.
List<ScanSnapshot>	getScanSnapshotList(Long releaseId) Scan snapshot refers to a particular point in history when statistics are reevaluated, such as when a scan is completed.
boolean	isLoggedIn()
String	sendData(String endpointData, byte[] data, long len, long frag, long offset)
void	setBaseUrl(String baseUrl)
void	setPrincipal(String clientId, String clientSecret)
void	setProxy(Proxy proxy)
void	setProxy(String hostname, int port)
UploadStatus	uploadFile(UploadRequest req) If relaseId not on request object, looks up release ID based on application and release names, then tries to upload.

Methods inherited from class java.lang.Object

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

Constructor Detail

FoDAPI

public FoDAPI()

Method Detail

setPrincipal

public void setPrincipal(String clientId,
                         String clientSecret)

encodeURLParamUTF8

public String encodeURLParamUTF8(String param)
                          throws UnsupportedEncodingException

Parameters:

param -

Returns:

UTF-8 encoded parameter for requests

Throws:

UnsupportedEncodingException

authorize

public boolean authorize(String clientId,
                         String clientSecret)
                  throws IOException

Authenticates against FoD API and caches session token.

Parameters:

clientId -

clientSecret -

Returns:

success

Throws:

IOException

authorize

public boolean authorize()
                  throws IOException

Authenticates against FoD API and caches session token. Requires auth principal to be set beforehand.

Returns:

success

Throws:

IOException

isLoggedIn

public boolean isLoggedIn()

getApplicationList

public Map<String,String> getApplicationList()
                                      throws IOException

Throws:

IOException

getReleaseId

public Long getReleaseId(String applicationName,
                         String releaseName)
                  throws IOException

Throws:

IOException

getRelease

public Release getRelease(Long releaseId)
                   throws IOException

Throws:

IOException

getRelease

public Release getRelease(String applicationName,
                          String releaseName)
                   throws IOException

Retrieves release info base on application name and release name. Please be aware this makes two calls on the back end.

Parameters:

applicationName -

releaseName -

Returns:

Throws:

IOException

getReleaseList

public List<Release> getReleaseList()
                             throws IOException

Retrieves all releases for the tenant, with a limited number of fields populated. Use the call to retrieve a single release by releaseId if you want all fields populated.

Returns:

Throws:

IOException

getReleaseList

public List<Release> getReleaseList(String applicationName)
                             throws IOException

Retrieves all releases for a given application name, with a limited number of fields populated. Use the call to retrieve a single release by releaseId if you want all fields populated.

Parameters:

applicationName -

Returns:

Throws:

IOException

getReleaseList

public List<Release> getReleaseList(Long applicationId)
                             throws IOException

Retrieves all releases for a given application name, with a limited number of fields populated. Use the call to retrieve a single release by releaseId if you want all fields populated.

Parameters:

applicationId -

Returns:

Throws:

IOException

getAssessmentTypeListWithRetry

public Map<String,String> getAssessmentTypeListWithRetry()
                                                  throws IOException

Throws:

IOException

getScanSnapshotList

public List<ScanSnapshot> getScanSnapshotList()
                                       throws IOException

Scan snapshot refers to a particular point in history when statistics are reevaluated, such as when a scan is completed. This call returns different data structures from the call to retrieve an individual scan by ID from under the Release context path.

Throws:

IOException

getScanSnapshotList

public List<ScanSnapshot> getScanSnapshotList(Long releaseId)
                                       throws IOException

Scan snapshot refers to a particular point in history when statistics are reevaluated, such as when a scan is completed. This call returns different data structures from the call to retrieve an individual scan by ID from under the Release context path.

Throws:

IOException

getScan

public Scan getScan(Long releaseId,
                    Long scanId)
             throws IOException

Retrieves information on a single scan, given a release and scan ID. The scan ID can be retrieved from one of the getSnapshotList methods, or from the fully populated Release object from the getRelease methods.

Parameters:

releaseId -

scanId -

Returns:

Throws:

IOException

uploadFile

public UploadStatus uploadFile(UploadRequest req)
                        throws IOException

If relaseId not on request object, looks up release ID based on application and release names, then tries to upload. Requires a zip file containing all relevant files already be created and referenced from the request object's uploadZip field.

Parameters:

req -

Returns:

Throws:

IOException

sendData

public String sendData(String endpointData,
                       byte[] data,
                       long len,
                       long frag,
                       long offset)

getBaseUrl

public String getBaseUrl()

setBaseUrl

public void setBaseUrl(String baseUrl)

getProxy

public Proxy getProxy()

setProxy

public void setProxy(Proxy proxy)

setProxy

public void setProxy(String hostname,
                     int port)

getHttpUrlConnection

protected HttpURLConnection getHttpUrlConnection(String requestMethod,
                                                 URL url)
                                          throws IOException

Throws:

IOException

collectInputStream

protected StringBuffer collectInputStream(InputStream is)
                                   throws IOException

Throws:

IOException

getDataJsonArray

protected com.google.gson.JsonArray getDataJsonArray(StringBuffer response)

getDataJsonElement

protected com.google.gson.JsonElement getDataJsonElement(String responseString)

getGson

protected com.google.gson.Gson getGson()