Guardium for Applications JavaScript API

The Guardium® for Applications JavaScript API exposes a set of objects and classes for use in JavaScript programs that run in the JavaScript engine to manipulate captured messages. You can use this API if the selection tool does not meet all your needs for some pages. By using this API, you can modify the content of HTTP messages as well as other message parameters, such as the URL.

When you use the selection tool to define masking actions, it creates scripts that are run when rule conditions are met. These scripts modify the HTTP messages that occur with the use of the application. If this process does not give you the results that you require, you can create your own scripts to manipulate the contents and properties of the HTTP messages. Designing these scripts requires that you understand the messages that are exchanged when users interact with the applications that you want to mask.

To use your custom scripts, identify the conditions for running the scripts, then create a mask in context action, and add one or more action items that invoke your custom scripts. In these scripts, you can use the objects and classes that are described here.

In addition to the objects and classes, the API provides a function that can be used for debug purposes:

dbgm(...);   //prints the supplied arguments to stdout.

For example,

dbgm('this ' + 'is' + ' a debug output');   //prints "this is a debug output"

You can insert values from the current class or object into the output string. For an example, see the json global object.

The following notation is used in describing the objects and classes:

[r] indicates that a property is read-only
[rw] indicates that a property is read/write
[] indicates that a parameter is optional.
nnn:ttt is a property definition where nnn is a property name and ttt is its type
"any property" means any nnn
mmm(nnn:ttt[, ...]) is a method definition where mmm is the method name, nnn is a parameter name, and ttt is the parameter type. The [, ...] indicates that additional parameter:type pairs can be specified.