com.contrastsecurity.sdk

Class ContrastSDK

java.lang.Object

com.contrastsecurity.sdk.ContrastSDK

public class ContrastSDK
extends java.lang.Object

Entry point for using the Contrast REST API. Make an instance of this class and call methods. Easy!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContrastSDK.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECTION_TIMEOUT Default connection timeout.
static int	DEFAULT_READ_TIMEOUT Default read timeout.

Method Summary

Modifier and Type	Method and Description
GenericResponse	clearNotifications(java.lang.String organizationId) Clear notifications for the org.
Application	createApplication(java.lang.String organizationId, ApplicationCreateRequest request) Creates an application without a server that is meant to be instrumented later.
TagsResponse	createTag(java.lang.String organizationId, Tags tags) Create a vulnerability tag for the organization whose ID is passed in.
TagsResponse	deleteVulnerabilityTag(java.lang.String organizationId, java.lang.String traceId, Tag tag) Delete the tag for the vulnerability whose ID is passed in.
void	downloadAttestationReport(java.lang.String organizationId, java.lang.String userId, java.lang.String reportId) Get the vulnerabilities in the organization whose ID is passed in.
void	downloadFile(HttpMethod method, java.lang.String path, java.lang.String saveDir)
GenericResponse	generateAttestationReport(java.lang.String organizationId, java.lang.String appId, AttestationCreateRequest request) Generate an attestation report for the application whose ID is passed in.
byte[]	getAgent(AgentType type, java.lang.String organizationId) Download a contrast.jar agent associated with this account.
byte[]	getAgent(AgentType type, java.lang.String organizationId, java.lang.String profileName) Download a contrast.jar agent associated with this account.
Applications	getApplication(java.lang.String organizationId, java.lang.String appId) Get summary information about a single app without expandValues.
Applications	getApplication(java.lang.String organizationId, java.lang.String appId, java.util.EnumSet<FilterForm.ApplicationExpandValues> expandValues) Get summary information about a single app.
Application	getApplicationByNameAndLanguage(java.lang.String orgId, java.lang.String appName, AgentType language) Gets a single application based on the org, name, and language
Applications	getApplications(java.lang.String organizationId) Get the list of applications being monitored by Contrast.
Applications	getApplicationsNames(java.lang.String organizationId)
AssessLicenseOverview	getAssessLicensing(java.lang.String organizationId) Get all Assess Licensing for an Organizations.
Coverage	getCoverage(java.lang.String organizationId, java.lang.String appId) Return coverage data about the monitored Contrast application.
java.util.List<JobOutcomePolicy>	getEnabledJobOutcomePolicies(java.lang.String organizationId) Gets a list of enabled Job Outcome policies in an organization
java.util.List<JobOutcomePolicy>	getEnabledJoboutcomePoliciesByApplication(java.lang.String organizationId, java.lang.String appId) Gets a list of enabeld Job Outcome Policies in an organization that applies to an application
EventSummaryResponse	getEventSummary(java.lang.String organizationId, java.lang.String traceId) Get the event for the vulnerability ID that is passed in.
Applications	getFilteredApplications(java.lang.String organizationId, ApplicationFilterForm applicationFilterForm) Get the list of filtered applications being monitored by Contrast.
GlobalProperties	getGlobalProperties() Gets the global properties from TeamServer.
HttpRequestResponse	getHttpRequest(java.lang.String organizationId, java.lang.String traceId) Get the http request for the vulnerability ID that is passed in.
Libraries	getLibraries(java.lang.String organizationId, LibraryFilterForm filterForm) Return the libraries of the Contrast organization.
Libraries	getLibraries(java.lang.String organizationId, java.lang.String appId)
Libraries	getLibraries(java.lang.String organizationId, java.lang.String appId, java.util.EnumSet<FilterForm.LibrariesExpandValues> expandValues) Return the libraries of the monitored Contrast application.
Libraries	getLibrariesWithFilter(java.lang.String organizationId, LibraryFilterForm filterForm) Return the libraries of the Contrast organization.
Libraries	getLibrariesWithFilter(java.lang.String organizationId, java.lang.String appId, LibraryFilterForm filterForm) Return the libraries of the monitored Contrast application.
LibraryScores	getLibraryScores(java.lang.String organizationId) Return the library Scores for an Organization.
LibraryStats	getLibraryStats(java.lang.String organizationId) Return the library Stats for an Organization.
Applications	getLicensedApplications(java.lang.String organizationId) Get the list of licensed applications being monitored by Contrast.
TraceNotesResponse	getNotes(java.lang.String organizationId, java.lang.String appId, java.lang.String traceId, TraceFilterForm form) Get the notes (discussion) for the vulnerability ID in the application whose ID is passed in.
NotificationsResponse	getNotifications(java.lang.String organizationId, TraceFilterForm form) Get notifications for the org.
Users	getOrganizationUsers(java.lang.String organizationId) Get all users for an organization.
Organizations	getProfileDefaultOrganizations() Get the default organization for the user profile.
Organizations	getProfileOrganizations() Get all organizations for the user profile.
RecommendationResponse	getRecommendation(java.lang.String organizationId, java.lang.String traceId) Get the recommendation for the vulnerability ID that is passed in.
RouteCoverageResponse	getRouteCoverage(java.lang.String organizationId, java.lang.String appId, RouteCoverageBySessionIDAndMetadataRequest metadata) Return route coverage data about the monitored Contrast application.
Rules	getRules(java.lang.String organizationId) Get the rules for an organization
Servers	getServers(java.lang.String organizationId, ServerFilterForm filterForm) Return the servers of the monitored Contrast application.
Servers	getServersWithFilter(java.lang.String organizationId, ServerFilterForm filterForm) Return the servers of the monitored Contrast application.
ServerTagsResponse	getServerTags(java.lang.String organizationId, java.lang.String appId) Get server tags for the org.
MetadataFilterResponse	getSessionMetadataForApplication(java.lang.String organizationId, java.lang.String appId, TraceFilterForm form) Get the available session metadata values in the application whose ID is passed in.
StoryResponse	getStory(java.lang.String organizationId, java.lang.String traceId) Get the story for the vulnerability ID that is passed in.
TagsResponse	getTagsByTrace(java.lang.String organizationId, java.lang.String traceId) Get the tags for the vulnerability whose ID is passed in.
Traces	getTraceFilterByRule(java.lang.String organizationId, java.lang.String appId, java.util.List<java.lang.String> ruleNames) Deprecated.
TraceListing	getTraceFilters(java.lang.String organizationId, java.lang.String appId) Get the filters for the traces in the application.
TraceListing	getTraceFiltersByType(java.lang.String organizationId, java.lang.String appId, TraceFilterType type)
Traces	getTraces(java.lang.String organizationId, java.lang.String appId, TraceFilterBody filters) Get the vulnerabilities in the application that match specific metadata filters.
Traces	getTraces(java.lang.String organizationId, java.lang.String appId, TraceFilterForm form) Deprecated. Use getTraces instead.
Traces	getTracesInOrg(java.lang.String organizationId, TraceFilterForm form) Get the vulnerabilities in the organization whose ID is passed in.
Traces	getTracesWithFilter(java.lang.String organizationId, java.lang.String appId, TraceFilterType traceFilterType, TraceFilterKeycode keycode, TraceFilterForm form) Get the vulnerabilities in the application whose ID is passed in with a filter.
TracesWithResponse	getTracesWithResponse(java.lang.String organizationId, java.lang.String appId, TraceFilterForm form) Get the vulnerabilities in the application whose ID is passed in.
TagsResponse	getTraceTagsByOrganization(java.lang.String organizationId) Get the vulnerability tags for the organization whose ID is passed in.
TagsResponse	getVulnTagsByApplication(java.lang.String organizationId, java.lang.String appId) Get the available vulnerability tags in the application whose ID is passed in.
VulnerabilityTrend	getYearlyNewVulnTrend(java.lang.String organizationId) Get New (New Open and New Closed each month) Vulnerability Trend for an Organizations.
VulnerabilityTrend	getYearlyVulnTrend(java.lang.String organizationId) Get Total (Total Open and Total Closed each month) Vulnerability Trend for an Organizations.
VulnerabilityTrend	getYearlyVulnTrendForApplication(java.lang.String organizationId, java.lang.String appId) Get all Vulnerability Trend for an Application.
java.net.HttpURLConnection	makeConnection(java.lang.String url, java.lang.String method)
java.io.InputStream	makeRequest(HttpMethod method, java.lang.String path)
java.io.InputStream	makeRequestWithBody(HttpMethod method, java.lang.String path, java.lang.String body, MediaType mediaType)
MakeRequestResponse	makeRequestWithResponse(HttpMethod method, java.lang.String path)
SecurityCheck	makeSecurityCheck(java.lang.String organizationId, SecurityCheckForm securityCheckForm) Make a security check in a given organization by the security check form
ScanManager	scan(java.lang.String organizationId)
void	setConnectionTimeout(int timeout) Sets a custom connection timeout for all SDK requests.
void	setReadTimeout(int timeout) Set a custom read timeout for all SDK requests.
GenericResponse	setTraceStatus(java.lang.String organizationId, java.lang.String statusRequest)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

Default connection timeout. If connection timeout its set to this value, custom timeout will be ignored and requests will take the default value that its usually assigned to them.

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

Default read timeout. If read timeout its set to this value, custom timeout will be ignored and requests will take default value that its usually assigned to them.

See Also:

Constant Field Values

Method Detail

scan

public ScanManager scan(java.lang.String organizationId)

getGlobalProperties

public GlobalProperties getGlobalProperties()
                                     throws java.io.IOException,
                                            UnauthorizedException

Gets the global properties from TeamServer.

Returns:

GlobalProperties with the properties from TeamServer.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getAssessLicensing

public AssessLicenseOverview getAssessLicensing(java.lang.String organizationId)
                                         throws java.io.IOException,
                                                UnauthorizedException

Get all Assess Licensing for an Organizations.

Parameters:

organizationId - the ID of the organization

Returns:

AssessLicenseOverview with Assess Licensing for an Oeg.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getYearlyVulnTrend

public VulnerabilityTrend getYearlyVulnTrend(java.lang.String organizationId)
                                      throws java.io.IOException,
                                             UnauthorizedException

Get Total (Total Open and Total Closed each month) Vulnerability Trend for an Organizations.

Parameters:

organizationId - the ID of the organization

Returns:

VulnerabilityTrend with the yearly Vulnerability Trend for an Oeg.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getYearlyNewVulnTrend

public VulnerabilityTrend getYearlyNewVulnTrend(java.lang.String organizationId)
                                         throws java.io.IOException,
                                                UnauthorizedException

Get New (New Open and New Closed each month) Vulnerability Trend for an Organizations.

Parameters:

organizationId - the ID of the organization

Returns:

VulnerabilityTrend with the yearly Vulnerability Trend for an Oeg.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getYearlyVulnTrendForApplication

public VulnerabilityTrend getYearlyVulnTrendForApplication(java.lang.String organizationId,
                                                           java.lang.String appId)
                                                    throws java.io.IOException,
                                                           UnauthorizedException

Get all Vulnerability Trend for an Application.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

Returns:

VulnerabilityTrend with the yearly Vulnerability Trend for an Oeg.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getProfileOrganizations

public Organizations getProfileOrganizations()
                                      throws java.io.IOException,
                                             UnauthorizedException

Get all organizations for the user profile.

Returns:

Organization objects with a list of disabled and valid organizations for the user.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getOrganizationUsers

public Users getOrganizationUsers(java.lang.String organizationId)
                           throws java.io.IOException,
                                  UnauthorizedException

Get all users for an organization.

Parameters:

organizationId - the ID of the organization

Returns:

A List of User Objects.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getProfileDefaultOrganizations

public Organizations getProfileDefaultOrganizations()
                                             throws java.io.IOException,
                                                    UnauthorizedException

Get the default organization for the user profile.

Returns:

Organization object with the default Organizaiton.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

createApplication

public Application createApplication(java.lang.String organizationId,
                                     ApplicationCreateRequest request)
                              throws java.io.IOException,
                                     UnauthorizedException,
                                     ApplicationCreateException

Creates an application without a server that is meant to be instrumented later.

Parameters:

organizationId -

request -

Returns:

Throws:

java.io.IOException

UnauthorizedException

ApplicationCreateException

getApplicationByNameAndLanguage

public Application getApplicationByNameAndLanguage(java.lang.String orgId,
                                                   java.lang.String appName,
                                                   AgentType language)
                                            throws java.io.IOException,
                                                   UnauthorizedException

Gets a single application based on the org, name, and language

Parameters:

orgId - ID of the organization

appName - Application name when the application was first created

language - Language of the application

Returns:

the Application found, returns null if the application is not found

Throws:

java.io.IOException

UnauthorizedException

getApplication

public Applications getApplication(java.lang.String organizationId,
                                   java.lang.String appId)
                            throws java.io.IOException,
                                   UnauthorizedException

Get summary information about a single app without expandValues.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

Returns:

Applications object that contains one Application; wrapper

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getApplication

public Applications getApplication(java.lang.String organizationId,
                                   java.lang.String appId,
                                   java.util.EnumSet<FilterForm.ApplicationExpandValues> expandValues)
                            throws java.io.IOException,
                                   UnauthorizedException

Get summary information about a single app.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

expandValues - Expand values to filter on

Returns:

Applications object that contains one Application; wrapper

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getApplications

public Applications getApplications(java.lang.String organizationId)
                             throws UnauthorizedException,
                                    java.io.IOException

Get the list of applications being monitored by Contrast.

Parameters:

organizationId - the ID of the organization

Returns:

Applications object that contains the list of Application's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getFilteredApplications

public Applications getFilteredApplications(java.lang.String organizationId,
                                            ApplicationFilterForm applicationFilterForm)
                                     throws UnauthorizedException,
                                            java.io.IOException

Get the list of filtered applications being monitored by Contrast.

Parameters:

organizationId - the ID of the organization

applicationFilterForm - Query params to add more info to response

Returns:

Applications object that contains the list of Application's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getLicensedApplications

public Applications getLicensedApplications(java.lang.String organizationId)
                                     throws UnauthorizedException,
                                            java.io.IOException

Get the list of licensed applications being monitored by Contrast.

Parameters:

organizationId - the ID of the organization

Returns:

Applications object that contains the list of Application's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getApplicationsNames

public Applications getApplicationsNames(java.lang.String organizationId)
                                  throws UnauthorizedException,
                                         java.io.IOException

Throws:

UnauthorizedException

java.io.IOException

getRouteCoverage

public RouteCoverageResponse getRouteCoverage(java.lang.String organizationId,
                                              java.lang.String appId,
                                              RouteCoverageBySessionIDAndMetadataRequest metadata)
                                       throws java.io.IOException,
                                              UnauthorizedException

Return route coverage data about the monitored Contrast application.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

metadata - option session metadata keys and values to return route coverage based on

Returns:

RouteCoverage object for the given app

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getCoverage

public Coverage getCoverage(java.lang.String organizationId,
                            java.lang.String appId)
                     throws java.io.IOException,
                            UnauthorizedException

Return coverage data about the monitored Contrast application.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

Returns:

Coverage object for the given app

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getLibraries

public Libraries getLibraries(java.lang.String organizationId,
                              LibraryFilterForm filterForm)
                       throws java.io.IOException,
                              UnauthorizedException

Return the libraries of the Contrast organization.

Parameters:

organizationId - the ID of the organization

filterForm - FilterForm query parameters

Returns:

Libraries object that contains the list of Library objects

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getLibrariesWithFilter

public Libraries getLibrariesWithFilter(java.lang.String organizationId,
                                        LibraryFilterForm filterForm)
                                 throws java.io.IOException,
                                        UnauthorizedException

Return the libraries of the Contrast organization.

Parameters:

organizationId - the ID of the organization

filterForm - FilterForm query parameters

Returns:

Libraries object that contains the list of Library objects

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getLibraries

public Libraries getLibraries(java.lang.String organizationId,
                              java.lang.String appId)
                       throws java.io.IOException,
                              UnauthorizedException

Throws:

java.io.IOException

UnauthorizedException

getLibraries

public Libraries getLibraries(java.lang.String organizationId,
                              java.lang.String appId,
                              java.util.EnumSet<FilterForm.LibrariesExpandValues> expandValues)
                       throws java.io.IOException,
                              UnauthorizedException

Return the libraries of the monitored Contrast application.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

expandValues - Query params to add more info to response

Returns:

Libraries object that contains the list of Library objects

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getLibrariesWithFilter

public Libraries getLibrariesWithFilter(java.lang.String organizationId,
                                        java.lang.String appId,
                                        LibraryFilterForm filterForm)
                                 throws java.io.IOException,
                                        UnauthorizedException

Return the libraries of the monitored Contrast application.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

filterForm - FilterForm query parameters

Returns:

Libraries object that contains the list of Library objects

Throws:

java.io.IOException - if there was a communication problem

UnauthorizedException

getLibraryScores

public LibraryScores getLibraryScores(java.lang.String organizationId)
                               throws java.io.IOException,
                                      UnauthorizedException

Return the library Scores for an Organization.

Parameters:

organizationId - the ID of the organization

Returns:

LibraryScores object that contains the Library scores for an Org

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getLibraryStats

public LibraryStats getLibraryStats(java.lang.String organizationId)
                             throws java.io.IOException,
                                    UnauthorizedException

Return the library Stats for an Organization.

Parameters:

organizationId - the ID of the organization

Returns:

LibraryScores object that contains the Library stats for an Org

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getServers

public Servers getServers(java.lang.String organizationId,
                          ServerFilterForm filterForm)
                   throws java.io.IOException,
                          UnauthorizedException

Return the servers of the monitored Contrast application.

Parameters:

organizationId - the ID of the organization

filterForm - FilterForm query parameters

Returns:

Servers object that contains the list of Library objects

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getServersWithFilter

public Servers getServersWithFilter(java.lang.String organizationId,
                                    ServerFilterForm filterForm)
                             throws java.io.IOException,
                                    UnauthorizedException

Return the servers of the monitored Contrast application.

Parameters:

organizationId - the ID of the organization

filterForm - FilterForm query parameters

Returns:

Servers object that contains the list of Library objects

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getTraces

@Deprecated
public Traces getTraces(java.lang.String organizationId,
                                    java.lang.String appId,
                                    TraceFilterForm form)
                             throws java.io.IOException,
                                    UnauthorizedException

Deprecated. Use getTraces instead.

Get the vulnerabilities in the application whose ID is passed in.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

form - FilterForm query parameters

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getTraces

public Traces getTraces(java.lang.String organizationId,
                        java.lang.String appId,
                        TraceFilterBody filters)
                 throws java.io.IOException,
                        UnauthorizedException

Get the vulnerabilities in the application that match specific metadata filters.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

filters - TraceMetadataFilters filters to query on

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getTracesWithResponse

public TracesWithResponse getTracesWithResponse(java.lang.String organizationId,
                                                java.lang.String appId,
                                                TraceFilterForm form)
                                         throws java.io.IOException,
                                                UnauthorizedException

Get the vulnerabilities in the application whose ID is passed in.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

form - FilterForm query parameters

Returns:

TracesWithResponse object that contains the list of Trace's and the response code

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getNotes

public TraceNotesResponse getNotes(java.lang.String organizationId,
                                   java.lang.String appId,
                                   java.lang.String traceId,
                                   TraceFilterForm form)
                            throws java.io.IOException,
                                   UnauthorizedException

Get the notes (discussion) for the vulnerability ID in the application whose ID is passed in.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

traceId - the ID of the vulnerability

form - FilterForm query parameters

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getRecommendation

public RecommendationResponse getRecommendation(java.lang.String organizationId,
                                                java.lang.String traceId)
                                         throws java.io.IOException,
                                                UnauthorizedException

Get the recommendation for the vulnerability ID that is passed in.

Parameters:

organizationId - the ID of the organization

traceId - the ID of the vulnerability

Returns:

RecommendationResponse object that contains the recommendation text, cwe and owasp links, rule references, and any custom recommendations or rule references, and response

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getStory

public StoryResponse getStory(java.lang.String organizationId,
                              java.lang.String traceId)
                       throws java.io.IOException,
                              UnauthorizedException

Get the story for the vulnerability ID that is passed in.

Parameters:

organizationId - the ID of the organization

traceId - the ID of the vulnerability

Returns:

StoryResponse object that contains the story, which contains a list of chapters, and a set properties

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getEventSummary

public EventSummaryResponse getEventSummary(java.lang.String organizationId,
                                            java.lang.String traceId)
                                     throws java.io.IOException,
                                            UnauthorizedException

Get the event for the vulnerability ID that is passed in.

Parameters:

organizationId - the ID of the organization

traceId - the ID of the vulnerability

Returns:

EventSummaryResponse object that contains the risk, evidence, and list of events

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getHttpRequest

public HttpRequestResponse getHttpRequest(java.lang.String organizationId,
                                          java.lang.String traceId)
                                   throws java.io.IOException,
                                          UnauthorizedException

Get the http request for the vulnerability ID that is passed in.

Parameters:

organizationId - the ID of the organization

traceId - the ID of the vulnerability

Returns:

HttpRequestResponse object that contains the request object and the reason text.

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getVulnTagsByApplication

public TagsResponse getVulnTagsByApplication(java.lang.String organizationId,
                                             java.lang.String appId)
                                      throws java.io.IOException,
                                             UnauthorizedException

Get the available vulnerability tags in the application whose ID is passed in.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

Returns:

TagsResponse object that contains the list of Tags

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getSessionMetadataForApplication

public MetadataFilterResponse getSessionMetadataForApplication(java.lang.String organizationId,
                                                               java.lang.String appId,
                                                               TraceFilterForm form)
                                                        throws java.io.IOException,
                                                               UnauthorizedException

Get the available session metadata values in the application whose ID is passed in.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

form - FilterForm query parameters

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

generateAttestationReport

public GenericResponse generateAttestationReport(java.lang.String organizationId,
                                                 java.lang.String appId,
                                                 AttestationCreateRequest request)
                                          throws java.io.IOException,
                                                 UnauthorizedException,
                                                 ApplicationCreateException

Generate an attestation report for the application whose ID is passed in.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

request -

Throws:

java.io.IOException

UnauthorizedException

ApplicationCreateException

downloadAttestationReport

public void downloadAttestationReport(java.lang.String organizationId,
                                      java.lang.String userId,
                                      java.lang.String reportId)
                               throws java.io.IOException,
                                      UnauthorizedException

Get the vulnerabilities in the organization whose ID is passed in.

Parameters:

organizationId - the ID of the organization

userId - the id of the user who requested the report

reportId - the id of the report that was generated

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getNotifications

public NotificationsResponse getNotifications(java.lang.String organizationId,
                                              TraceFilterForm form)
                                       throws java.io.IOException,
                                              UnauthorizedException

Get notifications for the org.

Parameters:

organizationId - the ID of the organization

form - FilterForm query parameters

Returns:

Notifications object that contains the response from the API

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getServerTags

public ServerTagsResponse getServerTags(java.lang.String organizationId,
                                        java.lang.String appId)
                                 throws java.io.IOException,
                                        UnauthorizedException

Get server tags for the org.

Parameters:

organizationId - the ID of the organization

appId - the ID of the app

Returns:

ServerTagsResponse object that contains the server tags

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

deleteVulnerabilityTag

public TagsResponse deleteVulnerabilityTag(java.lang.String organizationId,
                                           java.lang.String traceId,
                                           Tag tag)
                                    throws java.io.IOException,
                                           UnauthorizedException

Delete the tag for the vulnerability whose ID is passed in.

Parameters:

organizationId - the ID of the organization

traceId - the ID of the vulnerability

tag - the tag name/value to delete

Returns:

TagsResponse object that contains the http response and success message

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getTagsByTrace

public TagsResponse getTagsByTrace(java.lang.String organizationId,
                                   java.lang.String traceId)
                            throws java.io.IOException,
                                   UnauthorizedException

Get the tags for the vulnerability whose ID is passed in.

Parameters:

organizationId - the ID of the organization

traceId - the ID of the vulnerability

Returns:

TagsResponse object that contains the http response and success message and the list of Tags

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getTraceTagsByOrganization

public TagsResponse getTraceTagsByOrganization(java.lang.String organizationId)
                                        throws java.io.IOException,
                                               UnauthorizedException

Get the vulnerability tags for the organization whose ID is passed in.

Parameters:

organizationId - the ID of the organization

Returns:

TagsResponse object that contains the http response and success message and the list of Tags

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

createTag

public TagsResponse createTag(java.lang.String organizationId,
                              Tags tags)
                       throws java.io.IOException,
                              UnauthorizedException

Create a vulnerability tag for the organization whose ID is passed in.

Parameters:

organizationId - the ID of the organization

Returns:

TagsResponse object that contains the http response and success message

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

clearNotifications

public GenericResponse clearNotifications(java.lang.String organizationId)
                                   throws java.io.IOException,
                                          UnauthorizedException

Clear notifications for the org.

Parameters:

organizationId - the ID of the organization

Returns:

GenericResponse object that contains the response from the server

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getTracesInOrg

public Traces getTracesInOrg(java.lang.String organizationId,
                             TraceFilterForm form)
                      throws java.io.IOException,
                             UnauthorizedException

Get the vulnerabilities in the organization whose ID is passed in.

Parameters:

organizationId - the ID of the organization

form - FilterForm query parameters

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getTraceFilters

public TraceListing getTraceFilters(java.lang.String organizationId,
                                    java.lang.String appId)
                             throws java.io.IOException,
                                    UnauthorizedException

Get the filters for the traces in the application.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

Returns:

TraceListing object that contains the trace filters for the application

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getTraceFiltersByType

public TraceListing getTraceFiltersByType(java.lang.String organizationId,
                                          java.lang.String appId,
                                          TraceFilterType type)
                                   throws java.io.IOException,
                                          UnauthorizedException

Throws:

java.io.IOException

UnauthorizedException

getTracesWithFilter

public Traces getTracesWithFilter(java.lang.String organizationId,
                                  java.lang.String appId,
                                  TraceFilterType traceFilterType,
                                  TraceFilterKeycode keycode,
                                  TraceFilterForm form)
                           throws java.io.IOException,
                                  UnauthorizedException

Get the vulnerabilities in the application whose ID is passed in with a filter.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

traceFilterType - filter type

keycode - id or key to filter on

form - FilterForm query parameters

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

setTraceStatus

public GenericResponse setTraceStatus(java.lang.String organizationId,
                                      java.lang.String statusRequest)
                               throws java.io.IOException,
                                      UnauthorizedException

Throws:

java.io.IOException

UnauthorizedException

getTraceFilterByRule

@Deprecated
public Traces getTraceFilterByRule(java.lang.String organizationId,
                                               java.lang.String appId,
                                               java.util.List<java.lang.String> ruleNames)
                                        throws java.io.IOException,
                                               UnauthorizedException

Deprecated.

Get the vulnerabilities in the application by the rule.

Parameters:

organizationId - the ID of the organization

appId - the ID of the application

ruleNames - FilterForm query parameters

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

makeSecurityCheck

public SecurityCheck makeSecurityCheck(java.lang.String organizationId,
                                       SecurityCheckForm securityCheckForm)
                                throws java.io.IOException,
                                       UnauthorizedException

Make a security check in a given organization by the security check form

Parameters:

organizationId - the ID of the organization

securityCheckForm - the security check form

Returns:

the security check that was made

Throws:

java.io.IOException

UnauthorizedException

getEnabledJobOutcomePolicies

public java.util.List<JobOutcomePolicy> getEnabledJobOutcomePolicies(java.lang.String organizationId)
                                                              throws java.io.IOException,
                                                                     UnauthorizedException

Gets a list of enabled Job Outcome policies in an organization

Parameters:

organizationId - The organization ID

Returns:

The list of enabled Job Outcome Policies

Throws:

java.io.IOException

UnauthorizedException

getEnabledJoboutcomePoliciesByApplication

public java.util.List<JobOutcomePolicy> getEnabledJoboutcomePoliciesByApplication(java.lang.String organizationId,
                                                                                  java.lang.String appId)
                                                                           throws java.io.IOException,
                                                                                  UnauthorizedException

Gets a list of enabeld Job Outcome Policies in an organization that applies to an application

Parameters:

organizationId - The organization ID

appId - The Application ID

Returns:

the list of enabled Job Outcome Policies that apply to the application

Throws:

java.io.IOException

UnauthorizedException

getRules

public Rules getRules(java.lang.String organizationId)
               throws java.io.IOException,
                      UnauthorizedException

Get the rules for an organization

Parameters:

organizationId - the ID of the organization

Returns:

Traces object that contains the list of Trace's

Throws:

UnauthorizedException - if the Contrast account failed to authorize

java.io.IOException - if there was a communication problem

getAgent

public byte[] getAgent(AgentType type,
                       java.lang.String organizationId,
                       java.lang.String profileName)
                throws java.io.IOException,
                       UnauthorizedException

Download a contrast.jar agent associated with this account. The user should save this byte array to a file named 'contrast.jar'. This signature takes a parameter which contains the name of the saved engine profile to download.

Parameters:

type - the type of agent you want to download; Java, Java 1.5, .NET, or Node

profileName - the name of the saved engine profile to download,

organizationId - the ID of the organization,

Returns:

a byte[] array of the contrast.jar file contents, which the user should convert to a new File

Throws:

java.io.IOException - if there was a communication problem

UnauthorizedException - if authentication fails

getAgent

public byte[] getAgent(AgentType type,
                       java.lang.String organizationId)
                throws java.io.IOException,
                       UnauthorizedException

Download a contrast.jar agent associated with this account. The user should save this byte array to a file named 'contrast.jar'. This signature takes a parameter which contains the name of the saved engine profile to download.

This uses 'default' as the profile name.

Parameters:

type - the type of agent you want to download; Java, Java 1.5, .NET, or Node

organizationId - the ID of the organization,

Returns:

a byte[] array of the contrast.jar file contents, which the user should convert to a new File

Throws:

java.io.IOException - if there was a communication problem

UnauthorizedException - if authentication fails

makeRequestWithBody

public java.io.InputStream makeRequestWithBody(HttpMethod method,
                                               java.lang.String path,
                                               java.lang.String body,
                                               MediaType mediaType)
                                        throws java.io.IOException,
                                               UnauthorizedException

Throws:

java.io.IOException

UnauthorizedException

makeRequest

public java.io.InputStream makeRequest(HttpMethod method,
                                       java.lang.String path)
                                throws java.io.IOException,
                                       UnauthorizedException

Throws:

java.io.IOException

UnauthorizedException

makeRequestWithResponse

public MakeRequestResponse makeRequestWithResponse(HttpMethod method,
                                                   java.lang.String path)
                                            throws java.io.IOException,
                                                   UnauthorizedException

Throws:

java.io.IOException

UnauthorizedException

downloadFile

public void downloadFile(HttpMethod method,
                         java.lang.String path,
                         java.lang.String saveDir)
                  throws java.io.IOException,
                         UnauthorizedException

Throws:

java.io.IOException

UnauthorizedException

makeConnection

public java.net.HttpURLConnection makeConnection(java.lang.String url,
                                                 java.lang.String method)
                                          throws java.io.IOException

Throws:

java.io.IOException

setConnectionTimeout

public void setConnectionTimeout(int timeout)

Sets a custom connection timeout for all SDK requests. This value must be set before a call to makeConnection is done.

Parameters:

timeout - Timeout value in milliseconds.

setReadTimeout

public void setReadTimeout(int timeout)

Set a custom read timeout for all SDK requests. This value must be set before calling makeConnection method in order to take effect.

Parameters:

timeout - TImeout value in milliseconds