com.veracode.apiwrapper.wrappers

Class VastAPIWrapper

java.lang.Object

com.veracode.apiwrapper.AbstractAPIWrapper

com.veracode.apiwrapper.wrappers.VastAPIWrapper

public final class VastAPIWrapper
extends AbstractAPIWrapper

Provides access to the VAST API. The Veracode Vendor Application Security Testing program's APIs make it possible to automate vendor and enterprise tasks.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GET_SHARED_REPORT_INFO_URI
static java.lang.String	GET_SHARED_REPORT_LIST_URI
static java.lang.String	SHARED_REPORT_PDF_URI
static java.lang.String	SHARED_REPORT_URI

Fields inherited from class com.veracode.apiwrapper.AbstractAPIWrapper

BASE_ADDRESS, ENV_ADDRESS

Constructor Summary

Constructors

Constructor and Description
VastAPIWrapper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSharedReportInfo(java.lang.String app_id) Returns the information about a specific shared report, or, if you do not specify a shared report ID, of the latest report that was shared.
java.lang.String	getSharedReportInfo(java.lang.String app_id, java.lang.String shared_report_id) Returns the information about a specific shared report, or, if you do not specify a shared report ID, of the latest report that was shared.
java.lang.String	getSharedReportList(java.lang.String app_id) Returns a list of published, shared reports that are linked to the application.
java.lang.String	sharedReport(java.lang.String app_id, java.lang.String shared_report_id) Returns the details of a shared report.
byte[]	sharedReportPdf(java.lang.String app_id, java.lang.String shared_report_id) Returns the shared report PDF document.

Methods inherited from class com.veracode.apiwrapper.AbstractAPIWrapper

setOutputStream, setUpApiCredentials, setUpApiCredentials, setUpApiCredentials, setUpCredentials, setupMaxRetryCount, setUpProxy, setUpProxy, setUpProxy, setupTransactionId

Methods inherited from class java.lang.Object

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

Field Detail

GET_SHARED_REPORT_INFO_URI

public static final java.lang.String GET_SHARED_REPORT_INFO_URI

See Also:

Constant Field Values

GET_SHARED_REPORT_LIST_URI

public static final java.lang.String GET_SHARED_REPORT_LIST_URI

See Also:

Constant Field Values

SHARED_REPORT_URI

public static final java.lang.String SHARED_REPORT_URI

See Also:

Constant Field Values

SHARED_REPORT_PDF_URI

public static final java.lang.String SHARED_REPORT_PDF_URI

See Also:

Constant Field Values

Constructor Detail

VastAPIWrapper

public VastAPIWrapper()

Method Detail

getSharedReportInfo

public java.lang.String getSharedReportInfo(java.lang.String app_id)
                                     throws java.io.IOException

Returns the information about a specific shared report, or, if you do not specify a shared report ID, of the latest report that was shared.

Calls this URL: https://analysiscenter.veracode.com/api/3.0/getsharedreportinfo.do Schema File: https ://analysiscenter.veracode.com/resource/3.0/sharedreportinfo.xsd

Parameters:

app_id - A String that represents an Integer value. Required

Returns:

A String that represents the sharedreportinfo XML document, which references the sharedreportinfo.xsd schema.

Throws:

java.io.IOException

getSharedReportInfo

public java.lang.String getSharedReportInfo(java.lang.String app_id,
                                            java.lang.String shared_report_id)
                                     throws java.io.IOException

Returns the information about a specific shared report, or, if you do not specify a shared report ID, of the latest report that was shared.

Calls this URL: https://analysiscenter.veracode.com/api/3.0/getsharedreportinfo.do Schema File: https ://analysiscenter.veracode.com/resource/3.0/sharedreportinfo.xsd

Parameters:

app_id - A String that represents an Integer value. Required

shared_report_id - Optional. A String that represents an Integer value. You can get the shared report ID from the sharedreportlist.xml file that is returned by the getsharedreportlist.do call.

Returns:

A String that represents the sharedreportinfo XML document, which references the sharedreportinfo.xsd schema.

Throws:

java.io.IOException

getSharedReportList

public java.lang.String getSharedReportList(java.lang.String app_id)
                                     throws java.io.IOException

Returns a list of published, shared reports that are linked to the application.

Calls this URL: https://analysiscenter.veracode.com/api/3.0/getsharedreportlist.do Schema File: https ://analysiscenter.veracode.com/resource/3.0/sharedreportlist.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

Returns:

A String that represents the sharedreportlist XML document, which references the sharedreportlist.xsd schema.

Throws:

java.io.IOException

sharedReport

public java.lang.String sharedReport(java.lang.String app_id,
                                     java.lang.String shared_report_id)
                              throws java.io.IOException

Returns the details of a shared report.

Calls this URL: https://analysiscenter.veracode.com/api/3.0/sharedreport.do Schema File: https://analysiscenter.veracode.com/resource/summaryreport.xsd

Parameters:

app_id - Required. A String that represents an Integer value.

shared_report_id - Required. A String that represents an Integer value.

Returns:

A String that represents the summaryreport XML document, which references the summaryreport.xsd schema.

Throws:

java.io.IOException

sharedReportPdf

public byte[] sharedReportPdf(java.lang.String app_id,
                              java.lang.String shared_report_id)
                       throws java.io.IOException

Returns the shared report PDF document. You specify where you want the PDF to save.

Calls this URL: https://analysiscenter.veracode.com/api/3.0/sharedreportpdf.do

Parameters:

app_id - Required. A String that represents an Integer value.

shared_report_id - Required. A String that represents an Integer value.

Returns:

A that represents the summaryreport PDF document, which references the summaryreportpdf.xsd schema.

Throws:

java.io.IOException