Jump to main content

Product Documentation

Customer Support

HCL AppScan Source

Welcome
Introduction to HCL® AppScan® Source
Installing
Configuring
Administering
Developing
Extending product function
Reference
Glossary
Troubleshooting and support

Home
Reference
Review reference information for the product.
AppScan® Source Data Access API
The Data Access API provides access to AppScan® Source-generated assessment results, including findings and finding details. It also provides access to assessment metrics such as analysis date and time, lines of code, V-density, and number of findings.
Data Access API classes and methods

Reference
Review reference information for the product.
- The Ounce/Make build utility
  Ounce/Make is a tool that automates the importing of configuration information into AppScan® Source from build environments that use makefile. Ounce/Make eliminates the need to import configuration information from makefiles manually.
- AppScan® Source command line interface (CLI)
  The CLI is an interface to core AppScan® Source functionality.
- The Ounce/Ant build tool
  This section describes how to use Ounce/Ant, an AppScan® Source build utility that integrates AppScan Source and Apache Ant. Integrating Ounce/Ant with your Ant environment helps you automate builds and code assessments.
- AppScan® Source Data Access API
  The Data Access API provides access to AppScan® Source-generated assessment results, including findings and finding details. It also provides access to assessment metrics such as analysis date and time, lines of code, V-density, and number of findings.
  - Data Access API object model
  - Using the Data Access API
    You can find complete examples for a number of Data Access API scenarios in the SamplePublished.java and SampleSdk.java files included in <install_dir>\sdk\sample\com\ouncelabs\sdk\sample (where <install_dir> is the location of your AppScan® Source installation).
  - Data Access API classes and methods
    - AssessedFile
      The com.ouncelabs.sdk.assessment.AssessedFile class represents an assessment of an individual file. It provides access to assessment data for a file, such as its findings and statistics.
    - Assessment
      The com.ouncelabs.sdk.assessment.Assessment class represents an assessment of an application or a project.
    - AssessmentDiff
      The com.ouncelabs.sdk.assessment.AssessmentDiff class holds the difference between two assessments, providing the delta between the two assessments .
    - AssessmentFilter
      Use the com.ouncelabs.sdk.assessment.AssessmentFilter class to specify filtering criteria when retrieving published assessments.
    - AssessmentResults
      The com.ouncelabs.sdk.assessment.AssessmentResults class represents the entire assessment.
    - Call
      The com.ouncelabs.sdk.assessment.Call class represents a node in an AppScan® Source trace.
    - ClassificationType
      The com.ouncelabs.sdk.assessment.ClassificationType class represents the classification of a finding.
    - DateProximityUnit
      When com.ouncelabs.sdk.assessment.DateProximityUnit is paired with dateProximityDuration, the unit, such as days, weeks, and so forth, by which to count. Required when dateProximityDuration is specified. Valid units are described in this section.
    - Factory
      com.ouncelabs.sdk.Factory provides methods for initialization, logging in, and opening assessments. This class is the entry point into the Data Access API.
    - Finding
      The com.ouncelabs.sdk.assessment.Finding class represents an individual finding in an assessment. It provides access to all of the data associated with a finding, such as classification and severity.
    - Trace
      The com.ouncelabs.sdk.assessment.Trace class represents the AppScan® Source trace for a finding.
    - SeverityType
      The com.ouncelabs.sdk.assessment.SeverityType class represents the severity of a finding.
    - OunceException
      com.ouncelabs.sdk.assessment.OunceException is the exception class used by the Data Access API. To find more information about an exception, call getMessage() on the exception.
- Ounce/Maven plug-in
  This section describes the Ounce/Maven plug-in, which uses Maven, an Apache build tool, to integrate AppScan® Source into the Maven workflow.
- AppScan® Source for Automation
  The Automation Server (ounceautod) allows you to automate key aspects of the AppScan® Source workflow and integrate security with build environments during the software development life cycle (SDLC). The Automation Server allows you to queue requests to scan and publish assessments, and generate reports on the security of application code.
- Framework for Frameworks handling APIs
  AppScan® Source provides a set of Java™ APIs that allow you to add support for frameworks that are used in your applications. The classes and methods offered in these APIs allow you to account for frameworks for which built-in support is not provided.
- AppScan® Source client component error messages
- AppScan® Source for Analysis samples
  AppScan® Source for Analysis includes a sample applicationsample applications that you can use to familiarize yourself with the product.
- The AppScan® Source for Analysis work environment
  To get the most out of AppScan® Source, you should understand the basic concepts behind the AppScan Source for Analysis working environment and how to use the options that best fit your workflow.
- Views and windows
  AppScan® Source for Development views and windows provide alternative presentations of findings, support code editing, and allow you to navigate the information in your workbench. A view might appear by itself, or stacked with other views in a tabbed notebook. You can change the layout of a perspective or window layout by opening and closing views and by docking them in different positions in the Workbench window.
- CWE support
  The Common Weakness Enumeration (CWE) is an industry standard list that provides common names for publicly known software weaknesses. This topic lists the CWE IDs that are supported in the current version of AppScan® Source.

Data Access API classes and methods

This section describes the AppScan® Source Data Access classes and methods in detail. The classes are:

com.ouncelabs.sdk.Factory
com.ouncelabs.sdk.assessment.AssessedFile
com.ouncelabs.sdk.assessment.Assessment
com.ouncelabs.sdk.assessment.AssessmentDiff
com.ouncelabs.sdk.assessment.AssessmentResults
com.ouncelabs.sdk.assessment.Finding
com.ouncelabs.sdk.assessment.Trace
com.ouncelabs.sdk.assessment.Call
com.ouncelabs.sdk.assessment.SeverityType
com.ouncelabs.sdk.assessment.ClassificationType
com.ouncelabs.sdk.assessment.AssessmentFilter
com.ouncelabs.sdk.assessment.OunceException

AssessedFile
The com.ouncelabs.sdk.assessment.AssessedFile class represents an assessment of an individual file. It provides access to assessment data for a file, such as its findings and statistics.
Assessment
The com.ouncelabs.sdk.assessment.Assessment class represents an assessment of an application or a project.
AssessmentDiff
The com.ouncelabs.sdk.assessment.AssessmentDiff class holds the difference between two assessments, providing the delta between the two assessments .
AssessmentFilter
Use the com.ouncelabs.sdk.assessment.AssessmentFilter class to specify filtering criteria when retrieving published assessments.
AssessmentResults
The com.ouncelabs.sdk.assessment.AssessmentResults class represents the entire assessment.
Call
The com.ouncelabs.sdk.assessment.Call class represents a node in an AppScan Source trace.
ClassificationType
The com.ouncelabs.sdk.assessment.ClassificationType class represents the classification of a finding.
DateProximityUnit
When com.ouncelabs.sdk.assessment.DateProximityUnit is paired with dateProximityDuration, the unit, such as days, weeks, and so forth, by which to count. Required when dateProximityDuration is specified. Valid units are described in this section.
Factory
com.ouncelabs.sdk.Factory provides methods for initialization, logging in, and opening assessments. This class is the entry point into the Data Access API.
Finding
The com.ouncelabs.sdk.assessment.Finding class represents an individual finding in an assessment. It provides access to all of the data associated with a finding, such as classification and severity.
Trace
The com.ouncelabs.sdk.assessment.Trace class represents the AppScan Source trace for a finding.
SeverityType
The com.ouncelabs.sdk.assessment.SeverityType class represents the severity of a finding.
OunceException
com.ouncelabs.sdk.assessment.OunceException is the exception class used by the Data Access API. To find more information about an exception, call getMessage() on the exception.

Disclaimer
Privacy
Terms of use
Cookie Preferences