Server JavaScript Objects APIs

Javelin object javadoc

Javelin is the object representing the legacy screen. Actions can be defined and performed on the legacy screen by programming code using the Javelin object. This section contains the API documentation of the Javelin object.

• Fields detailed list
• Methods detailed list

Fields detailed list

This section presents the list of fields contained in Javelin object, with their description.

Table 3 - 1: Fields list

Methods detailed list

This section presents the list of methods contained in Javelin object, with their description and parameters.

Table 3 - 2: Methods list

Context object

Context is the object representing the context of execution of transactions or sequences. This section presents the context, how it works in Convertigo, and then contains the API documentation of the Context object.

Context general presentation

This section presents the Convertigo context :

Definition

Each time a request is sent to Convertigo, a context is created in the Convertigo Server engine. A context is a kind of dedicated environment and specific tunnel between the client and the Convertigo Server. It contains all the relevant information required to process the request: a copy of the requested project and all its necessary objects, the transaction or sequence execution scopes, cookies, variables… If a context already exists and is available, it can also be re-used, depending on conditions that are explained thereafter.

Identification

A Convertigo context is identified by a contextId, based on the session ID.

The standard template for generating the contextId is : < JSESSIONID>_< contextName>.

Let’s detail these two parts of the contextId :

• JSESSIONID : It is the HTTP session ID, identifier of the user session (like JSESSIONID in Tomcat). All requests made by the same client have to be done using the same HTTP session in order to keep using the same context.

• contextName : The context name differentiates several contexts created for the same HTTP session. By default, contextName value is “default”, corresponding to only one Convertigo context for a given HTTP session. When no context name is specified by the request, this default context name is always used and re-used. It is not the case in the following situations:
  • Unlike the HTTP session ID, which is fixed by the server at the first connection from a client, the context name can be chosen by the client and sent as a request parameter: __context=XXXX. Therefore, consecutive requests must use not only the same HTTP session but also the same context name to re-use the same execution context.
  • In the case of a transaction or sequence initiated by a sequence, through a Call Transaction or a Call Sequence step (not initiated directly by a client), the context name is automatically generated, and can also be specified in the call step.

Context object

The Convertigo developer has access to the execution context of a transaction or a sequence directly in this transaction or sequence, simply by using the context object. This object is usable in JavaScript code (in transaction’s core for a Legacy transaction, in a Transaction JS statement for an HTML transaction, in a Sequence JS step for a sequence, etc).

The context object can be useful to store data, for example variables, XML chunks, etc. and retrieve this data in another request execution during the same session, as well as to encode and decode data.

But the context object is also a useful tool to control some behaviors of the running transaction or sequence, like the cache storage or pool locking, or to add elements to the output XML, etc. See the complete API of the object on the section Context API documentation

Context API documentation

The following sections present the fields and methods of the Context object that are usable in transactions and sequences JavaScript code.

Fields detailed list

This section presents the list of fields contained in Context object, with their description.

Table 3 - 3: Context fields list

Methods detailed list

This section presents the list of methods contained in Context object, with their description and parameters.

Table 3 - 4: Context methods list

Interesting methods in Context fields

Some fields of Context object are themselves objects, containing interesting methods to use in Convertigo transactions and sequences JavaScript code. The following list present these objects methods, with their description and parameters.

Table 3 - 5: Interesting methods in Context fields

Project API documentation

The following sections present the methods of the project object that are usable in transactions and sequences JavaScript code.

Methods detailed list

This section presents the list of methods contained in project object, with their description.

Table 4 - 1: project methods list

Sample

var sharedObject = project.get("mySharedObject");
if (sharedObject == null) {
    project.set("mySharedObject", sharedObject = {});
}
sharedObject.lastCall = new Date();

Server API documentation

The following sections present the methods of the server object that are usable in transactions and sequences JavaScript code.

Methods detailed list

This section presents the list of methods contained in server object, with their description.

Table 4 - 1: server methods list

Sample

var sharedObject = server.get("mySharedObject");
if (sharedObject == null) {
    server.set("mySharedObject", sharedObject = {});
}
sharedObject.lastCall = new Date();

Include API documentation

The following sections present the global function include usable in transactions and sequences JavaScript code.

Function API

Sample

include("js/myCommonLib.js");
myCommonFunction();

Use API documentation

The following sections present the global function use usable in transactions and sequences JavaScript code.

Function API

Sample

var md5 = ("org.apache.commons.codec.digest.DigestUtils.md5Hex"); // saving time for next calls
log.message("'Hello World!' md5 is: " + md5("Hello World!"));

Add your own Java code or library

The JavaScript code can call Java classes already loaded by Convertigo (like some Apaches libraries or internal to Convertigo). You can also provide your own jar file or Java classes. Java classes or methods loading can be speedup by the use function. JDBC drivers can also be overridden with this feature.

Shared for all project

Java classes or jars can be added to the <convertigo workspace>/libs folder but not in sub folder. If you have classes files, you can add them to <convertigo workspace>/libs/classes folder.

For a specific project

Java classes or jars can be added to the <project dir>/libs folder but not in sub folder. If you have classes files, you can add them to <project dir>/libs/classes folder.