Class lw.env

Object
   |
   +--lw.env

class lw.env

Holds all methods for environment handling before actually calling the AJAX emulator.
Defined in doLogin.jsp

Field Detail

ajaxapplet

<static> {Applet} ajaxapplet

The applet embedded in this page, initially undefined.
Set by GLOBALS.appletStarted().

allClientIP

<static> {Array} allClientIP

All Client IP Addresses as returned by the loaded applet, initially empty.
Set by GLOBALS.appletStarted().

autoStart

<static> {boolean} autoStart

Specifies if the ajax client is started automatically.

clientIP

<static> {String} clientIP

The Client IP Address as returned by the loaded applet, initially empty. If present the format is 'hostname/address'
Set by GLOBALS.appletStarted().

environment

<static> {Object} environment

The current environment as read by the loaded applet, initially empty.
Set by GLOBALS.appletStarted().

lw.env

lw.env()

Holds all methods for environment handling.

buildPoolname

<static> String buildPoolname(<String> name, <int> number)

Replaces the first sequence of question marks with the appropriate padded number.

Parameters:
name - required: the name possibly containing question marks
number - required: the number

Returns:
the resulting string

collectParams

<static> boolean collectParams()

User callback: Extracts the necessary information from the environment or the text fields on this page. The resulting parameters are stored in the lwData object.

This is the starting point for customizations of the required values from the local (client) environment.

The local environment must be retrieved by a Java Applet first that will be started automatically in function myOnload.

Example 1:
Set up a station pool name without using a displayed text field.

	// to get the computer name, check for terminal server client first
	var computername = lw.env.environment['CLIENTNAME'];
	if (!computername || computername == "Console") {
	    computername = lw.env.environment['COMPUTERNAME'];
	}
	if (computername) {
		// you may need to change the pattern for building the poolname.
	    // question mark(s) will be replaced by the next available session index.
	    lwData.LOGWEB_StationName = lw.env.buildPoolname(computername + "??S", sessionIndex);
	    lwData.LOGWEB_PrinterName = lw.env.buildPoolname(computername + "??P", sessionIndex);
	}
 

Example 2:
Create a startup macro using the currently logged in local user.

	var username = lw.env.environment['USERNAME'];
	if (username) {
	    username = lw.env.buildPoolname(username + "?", sessionIndex);
	    lwData["LOGWEB_$-autoinit"] = '"<WAIT>nat sys=prod,etid=' + username + '<DUE1>"';
	}
 

Example 3:
Provide the client IP address in the Unix VT environment variable "PRINTER" and the user name in the variable "USER"

	var address = lw.env.clientIP.split('/')[1];
	if (address) {
	    lwData._VTEnvironment_PRINTER = address;
	}
	var username = lw.env.environment['USERNAME'];
	if (username) {
	    lwData._VTEnvironment_USER = username;
	}
 

Example 4:
display Station and Printer name in the AJAX status line if present

	if (lwData.LOGWEB_StationName || lwData.LOGWEB_PrinterName) {
	    lwData._StatusText = lwData.LOGWEB_StationName + "/" + lwData.LOGWEB_PrinterName;
	}
 

Returns:
true if parameters have been set successfully. If an error occurred this method notifies the user and returns false

See:
- allClientIP
- clientIP
- environment

createAppletTag

<static> void createAppletTag(<node> button)

Dynamically creates the applet tag for the ajax applet providing the names of the callback functions and puts it into the designated div element.

Parameters:
button - the button that activates this function. The button will be disabled to ensure the applet is loaded only once.

See:
- GLOBALS.appletStarted()

getClientIP

<static> String getClientIP(<Object> hdr)

Extracts the Client IP Address from the specified HTTP headers.

Parameters:
hdr - the HTTP headers as received by the server

Returns:
the Client IP Address

login

<static> void login()

Processes the user callback collectParams() first and fills the InputForm from the resulting lwData object. The form is then sent to the login page /login/index.jsp.