This documentation is not maintained. Please refer to doc.castsoftware.com/technologies to find the latest updates.

Summary: This document provides basic information about the extension providing jQuery support for Web applications.

What's New

  • jQuery SAP ajax call support
  • 2 new CVE Rules

Description

This extension provides support for jQuery.

In what situation should you install this extension?

If your Web application contains jQuery source code and you want to view these object types and their links with other objects, then you should install this extension:

  • Creates jQuery events and access points to services:
    • jQuery events: they represent a query in DOM tree
    • jQuery access points to web services: CAST_JQuery_GetResourceService, CAST_JQuery_PutResourceService, CAST_JQuery_PostResourceService
  • Creates links (direct or indirect) from jQuery events to jQuery access points to services (these links are created by the jQuery extension and the HTML5/JavaScript extension).
  • Links from the jQuery access points to services to different servers written in other languages are then created by the WBSlinker extension (an internal extension).
  • The following declarations will create a jQuery event:
$('#advancedLoginOptionsLink').bind('click', dm.login.toggle_advanced);
$('#advancedLoginOptionsLink').click(dm.login.toggle_advanced);
$('#advancedLoginOptionsLink').on('click', this.destroy.bind(this));....
  • The following declaration will create objects "call to web service" (these calls are resolved to web service operations on the server side for the following supported frameworks: Node.js, JAX-RS, Spring MVC:
/* GET REQUEST USING AJAX OR GET ANNOTATIONS */
$.ajax({
  url: url,
  data: data,
  success: success,
  dataType: dataType
});
 
$.get( "ajax/test.html", function( data ) {
  $( ".result" ).html( data );
  alert( "Load was performed." );
});
/* POST REQUEST USING AJAX OR POST ANNOTATIONS */
$.ajax({
  type: "POST",
  url: url,
  data: data,
  success: success,
  dataType: dataType
});
 
$.post( "ajax/test.html", function( data ) {
  $( ".result" ).html( data );
});

Transaction configuration

Default entry point is the HTML file content.

Supported jQuery versions

  • 1.0 - 3.x

Function Point, Quality and Sizing support

This extension provides the following support:

  • Function Points (transactions): a green tick indicates that OMG Function Point counting and Transaction Risk Index are supported
  • Quality and Sizing: a green tick indicates that CAST can measure size and that a minimum set of Quality Rules exist
Function Points
(transactions)
Quality and SizingSecurity
(tick)(tick)(error)

Comparison with existing support for JavaScript in CAST AIP

CAST AIP has provided support for analyzing JavaScript via its JEE and .NET analyzers (provided out of box in CAST AIP) for some time now. The HTML5/JavaScript extension (on which the jQuery extension depends) also provides support for JavaScript but with a focus on web applications. CAST highly recommends that you use this extension if your Application contains JavaScript and more specifically if you want to analyze a web application, however you should take note of the following:

  • You should ensure that you configure the extension to NOT analyze the back end web client part of a .NET or JEE application.
  • You should ensure that you configure the extension to ONLY analyze the front end web application built with the HTML5/JavaScript that communicates with the back end web client part of a .NET or JEE application.
  • If the back end web client part of a .NET or JEE application is analyzed with the jQuery extension and with the native .NET/JEE analyzers, then your results will reflect this - there will be duplicate objects and links (i.e. from the analyzer and from the extension) therefore impacting results and creating erroneous Function Point data.

Note that in CAST AIP 8.3.x support for analyzing JavaScript has been withdrawn from the JEE and .NET analyzers.

CAST AIP compatibility

This extension is compatible with:

CAST AIP release
Supported
8.3.x(tick)
8.2.x(tick)
8.1.x(tick)
8.0.x(tick)
7.3.4 and all higher 7.3.x releases(tick)

Supported DBMS servers

This extension is compatible with the following DBMS servers:

CAST AIP releaseCSSOracleMicrosoft
All supported releases(tick)(tick)(error)

Prerequisites

(tick)An installation of any compatible release of CAST AIP (see table above)

Dependencies with other extensions

Some CAST extensions require the presence of other CAST extensions in order to function correctly. The jQuery extension requires that the following other CAST extensions are also installed:

Note that when using the CAST Extension Downloader to download the extension and the Manage Extensions interface in CAST Server Manager to install the extension, any dependent extensions are automatically downloaded and installed for you. You do not need to do anything.

Download and installation instructions

Please see:

The latest release status of this extension can be seen when downloading it from the CAST Extend server.

Packaging, delivering and analyzing your source code

Please see: jQuery - Packaging, delivering and analyzing your source code

What results can you expect?

Once the analysis/snapshot generation has completed, you can view the results in the normal manner (for example via CAST Enlighten):

Objects

The following specific objects are displayed in CAST Enlighten:

IconDescription
jQuery Selector

jQuery $.ajax, $.get, $.getJSON, $.getScript

jQuery SAP sjax, syncGet, syncGetJSON, syncGetText

Get Resource Service

jQuery $.ajax, $.get, $.getJSON, $.getScript

 jQuery SAP syncPost Post Resource Service

jQuery $.ajax, $.get, $.getJSON, $.getScript Put Resource Service
jQuery $.ajax, $.get, $.getJSON, $.getScript Delete Resource Service

Structural Rules

The following structural rules are provided: