主页
参考
查看 HCL® AppScan® Source 的参考信息，包括使用实用程序、插件和 API。
AppScan® Source Data Access API
Data Access API 提供对 AppScan® Source 所生成的评估结果（包括结果和结果详细信息）的访问权。它还提供对评估度量值如分析日期和时间、代码行、V-Density 和结果数的访问权。
Data Access API 类和方法
Finding
com.ouncelabs.sdk.assessment.Finding 类表示评估中的个别结果。它提供对结果的所有关联数据的访问权，如分类和严重性。
Finding.getApiName

欢迎
欢迎阅读 HCL® AppScan® Source 文档。
新增功能
探索已添加到 AppScan® Source 的以下新功能 - 并请注意该发行版中已不推荐使用的任何特性和功能。
安装
了解如何安装、升级和激活 HCL® AppScan® Source。
配置
了解如何在 HCL® AppScan® Source 中配置应用程序、文件夹和项目，以及设置特性和属性。
管理
了解如何管理用户帐户和许可权、审计用户活动以及管理 HCL® AppScan® Source 中的集成。
扫描
本部分说明在 HCL® AppScan® Source 中如何扫描源代码和管理评估。
筛选和分析
通过对相似发现结果进行分组，安全分析人员或 IT 审计员可以对源代码问题进行分段和分类。此部分说明如何将 AppScan® Source 评估分类和对结果进行分析。
报告
安全分析人员和风险管理员可以访问对选定结果的报告，或一系列用于度量与软件安全最佳做法和法规要求是否一致的审计报告。本部分说明如何创建对聚集结果数据的报告。
扩展产品功能
了解如何扩展产品，以满足特定开发需求。
参考
查看 HCL® AppScan® Source 的参考信息，包括使用实用程序、插件和 API。
- Ounce/Make 构建实用程序
  Ounce/Make 是一种从使用 makefile 的构建环境自动将配置信息导入 AppScan® Source 的工具。通过使用 Ounce/Make 方法，将无需手动从 makefiles 导入配置信息；这是用于配置这些项目的推荐方法。
- AppScan® Source command line interface (CLI)
  CLI 是核心 AppScan® Source 功能的界面。
- Ounce/Ant 构建工具
  此部分描述如何使用 Ounce/Ant，它是用于集成 AppScan® Source 和 Apache Ant 的 AppScan Source 构建实用程序。将 Ounce/Ant 与 Ant 环境集成有助于将构建和代码评估自动化。
- AppScan® Source Data Access API
  Data Access API 提供对 AppScan® Source 所生成的评估结果（包括结果和结果详细信息）的访问权。它还提供对评估度量值如分析日期和时间、代码行、V-Density 和结果数的访问权。
  - Data Access API 对象模型
  - 使用 Data Access API
    您可以在 <install_dir>\sdk\sample\com\ouncelabs\sdk\sample（其中 <install_dir> 是 AppScan® Source 的安装位置）包含的 SamplePublished.java 和 SampleSdk.java 文件中找到许多 Data Access API 方案的完整示例。
  - Data Access API 类和方法
    - AssessedFile
      com.ouncelabs.sdk.assessment.AssessedFile 类表示个别文件的评估。它提供对文件的评估数据的访问权，如其结果和统计信息。
    - Assessment
      com.ouncelabs.sdk.assessment.Assessment 类表示应用程序或项目的评估。
    - AssessmentDiff
      com.ouncelabs.sdk.assessment.AssessmentDiff 类包含两个评估之间的差异，从而提供两个评估之间的变化量。
    - AssessmentFilter
      使用 com.ouncelabs.sdk.assessment.AssessmentFilter 类可在检索已发布的评估时指定过滤条件。
    - AssessmentResults
      com.ouncelabs.sdk.assessment.AssessmentResults 类表示整个评估。
    - Call
      com.ouncelabs.sdk.assessment.Call 类表示 AppScan® Source trace 中的节点。
    - ClassificationType
      com.ouncelabs.sdk.assessment.ClassificationType 类表示结果的分类。
    - DateProximityUnit
      当 com.ouncelabs.sdk.assessment.DateProximityUnit 与 dateProximityDuration 配对时，指的是用于计数的单位，如天、周等等。当已指定 dateProximityDuration 时为必需。此部分中描述了有效单位。
    - Factory
      com.ouncelabs.sdk.Factory 提供用于初始化、登录和打开评估的方法。此类是 Data Access API 的入口点。
    - Finding
      com.ouncelabs.sdk.assessment.Finding 类表示评估中的个别结果。它提供对结果的所有关联数据的访问权，如分类和严重性。
      - Finding.getFilename
      - Finding.getLineNumber
      - Finding.getApiName
        Finding.getCallerName
        Finding.getClassification
        Finding.getSeverity
        Finding.getVulnerabilityType
        Finding.getOriginalClassification
        Finding.getOriginalSeverity
        Finding.getOriginalVulnerabilityType
        Finding.getModifiedClassification
        Finding.getModifiedSeverity
        Finding.getModifiedVulnerabilityType
        Finding.getSrcContext
        Finding.getDefectSubmissionUser
        Finding.getDefectSubmissionDate
        Finding.getDefectInfo
        Finding.getProperties
        Finding.isExcluded
        Finding.getTrace
        Finding.getNotes
      - Trace
        com.ouncelabs.sdk.assessment.Trace 类表示结果的AppScan® Source trace。
      - SeverityType
        com.ouncelabs.sdk.assessment.SeverityType 类表示结果的严重性。
      - OunceException
        com.ouncelabs.sdk.assessment.OunceException 是 Data Access API 使用的异常类。要了解有关异常的更多信息，请在异常上调用 getMessage()。
  - Ounce/Maven 插件
    此部分描述 Ounce/Maven 插件，它使用 Maven（一种 Apache 构建工具）将 AppScan® Source 集成到 Maven 工作流程中。
  - AppScan® Source for Automation
    通过 Automation Server (ounceautod)，您可以在软件开发生命周期 (SDLC) 过程中使 AppScan® Source 工作流程的关键方面自动化，并且将安全性集成到构建环境中。通过 Automation Server，您可以将扫描和发布评估的请求进行排队，并生成有关应用程序代码安全性的报告。
  - Framework for Frameworks 处理 API
    AppScan® Source 提供了一组 Java™ API，使您可以添加对您应用程序中使用的框架的支持。在这些 API 中提供的类和方法使您可以处理没有提供内置支持的框架。
  - AppScan® Source 客户机组件错误消息
  - AppScan® Source for Analysis 样本
    AppScan® Source for Analysis 包含了可用于帮助您熟悉产品的样本应用程序样本应用程序。
  - AppScan® Source for Analysis 工作环境
    要充分利用 AppScan® Source，您应该了解 AppScan Source for Analysis 工作环境背后的基本概念以及如何使用最适合于您的工作流程的选项。
  - 视图和窗口
    AppScan® Source for Development 视图和窗口提供对结果的备选表示法，支持代码编辑并使您能够在工作台中浏览信息。视图可能单独显示，或者与其他视图以堆栈化方式显示在选项卡式笔记本中。您可以通过打开和关闭视图以及将其悬停在“工作台”窗口中的不同位置来更改透视图的布局或窗口布局。
  - CWE 支持
    常用弱点枚举 (CWE) 是一种行业标准列表，它提供了公众熟知的软件弱点的常见名称。该主题列出了 AppScan® Source 的当前版本中受支持的 CWE 标识。
- 术语表
  了解该产品的通用术语。
故障诊断和技术支持
帮助您在使用 HCL® AppScan® Source 时对问题进行故障诊断的自助信息、资源和工具。

`Finding.getApiName`

签名

public String getApiName()

描述

提供对此结果的 API 名称的访问权。

返回值

此结果的 API 名称。