Home
Reference
Review reference information for HCL® AppScan® Source, including using utilities, plug-ins, and APIs.
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.
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.
Using the Framework for Frameworks APIs
This section highlights the steps that are required when using the Framework for Frameworks APIs. Where appropriate, these steps will be related to the provided example, allowing you to follow along.
Creating a class that implements F4FHandler
To create a new framework handler, you must first create a class that implements F4FHandler. Two methods must be implemented to support the Framework for Frameworks functionality.

Welcome
Welcome to the documentation for HCL® AppScan® Source.
What's New
Explore these new features that have been added to AppScan® Source - and note any features and capabilities that have been deprecated in this release.
Installing
Learn how to install, upgrade, and activate HCL® AppScan® Source.
Configuring
Learn how to configure applications, folders, and projects, and set attributes and properties in HCL® AppScan® Source.
Administering
Learn how to administer user accounts and permissions, audit user activity, and manage integrations in HCL® AppScan® Source.
Scanning
This section explains how to scan your source code and manage assessments in HCL® AppScan® Source.
Triage and analysis
Grouping similar findings allows security analysts or IT auditors to segment and triage source code problems. This section explains how to triage AppScan® Source assessments and analyze results.
Reporting
Security analysts and risk managers can access reports of select findings or a series of audit reports that measure compliance with software security best practices and regulatory requirements. This section explains how to create reports of aggregate finding data.
Extending product function
Learn how to extend the product to meet specific development requirements.
Reference
Review reference information for HCL® AppScan® Source, including using utilities, plug-ins, and APIs.
- 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; this the recommended method of configuring these projects.
- 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
  - 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.
    - Main Framework for Frameworks API components
    - Using the Framework for Frameworks APIs
      This section highlights the steps that are required when using the Framework for Frameworks APIs. Where appropriate, these steps will be related to the provided example, allowing you to follow along.
      - About the example
      - Importing the example project into Eclipse
      - Creating a class that implements F4FHandler
        To create a new framework handler, you must first create a class that implements F4FHandler. Two methods must be implemented to support the Framework for Frameworks functionality.
      - Creating a manifest file for your handler
        Create a file named Manifest.txt to contain the information needed for your JAR's manifest when it is exported. Specifically, AppScan® Source will look for the Framework-Handler entry when loading your handler JAR to determine which class contains the F4FHandler functionality.
      - Creating a JAR for your handler
      - Exporting the JAR to waflgens
    - Common actions performed by the handler
    - Framework for Frameworks API classes and methods
      This section contains the Framework for Frameworks API classes and methods, abbreviated for Adobe™ PDF. To access the complete set of API documentation, launch the AppScan® Source for Analysis online help and navigate to Reference > Framework for Frameworks handling APIs > Framework for Frameworks API classes and methods.
    - High-level synthetic methods
    - Integrating a new web services Framework for Frameworks handler with the existing Web Service Description Language custom scanner
  - 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.
- Glossary
  Learn common product terminology.
Troubleshooting and support
Self-help information, resources, and tools to help you troubleshoot issues while using HCL® AppScan® Source.

Creating a class that implements `F4FHandler`

To create a new framework handler, you must first create a class that implements F4FHandler. Two methods must be implemented to support the Framework for Frameworks functionality.

Override `isApplicable`

Purpose: AppScan® Source calls isApplicable to determine if it should run your handler. If you return True, it will run your handler by calling handleApp. If you return False, nothing further will be called.

Note: isApplicable includes a check at the beginning of the method to ensure the application is a Java™ application before continuing.

Observe in the example: In the Ejb2xHandler, isApplicable first checks to see if the language is appropriate (as EJB is only present in Java™ applications). If the application is Java-based, isApplicable then searches for any instances of ejb-jar.xml, which is the required configuration file for an EJB 2 application. If configuration files are found, they are read into the handler and True is returned to let AppScan® Source know that it should call handleApp to deal with the information contained in the configuration files.

Override `handleApp`

Purpose: AppScan® Source calls handleApp to allow you to determine and set information about the framework or frameworks in use by the current application being scanned. The parameters F4FApp and F4FAction are used to get information about the application and set specifics about how to handle the frameworks that are present and that your handler handles.