Once the application configuration file contains the codebase server description, WebClient makes the description available, to the client at run time, as attributes of the CODEBASE-LOCATOR handle.

All the attributes listed are read-only.

Basic attributes

The following table lists the basic attributes of the CODEBASE-LOCATOR handle.

Table 1. Basic attributes of the CODEBASE-LOCATOR handle
Name Data type Description
END-USER-PROMPT Character Text string for the security prompt of an authentication dialog.Used only if WebClient must prompt for security information.
KEEP-CONNECTION-OPEN Logical If TRUE, any connection WebClient creates to download As Needed components will be kept open until all As Needed components have been downloaded to the end user's machine.
LOCATOR-TYPE Character AppServer or InternetServer.
NEEDS-APPSERVER-PROMPT Logical If TRUE, enables prompting for a user ID, password, and info string for accessing an application server. Applies only if LOCATOR-TYPE is AppServer.
NEEDS-PROMPT Logical If TRUE, enables prompting for a user ID and password for accessing the codebase server.If LOCATOR-TYPE is InternetServer, the prompt is for accessing a codebase residing on an Internet-based server. If LOCATOR-TYPE is AppServer, the prompt is for accessing the adapter for a codebase residing on an application server.
PERSISTENT-CACHE-DISABLED Logical If TRUE, the user is not given the option of saving authentication information past the end of the session.
URL Character URL of the server.

Security-cache attributes

The following table lists the attributes of the CODEBASE-LOCATOR handle that relate to the security cache.

Table 2. Security-cache attributes of the CODEBASE-LOCATOR handle
Name Data type Description
APPSERVER-INFO Character Info string to use for connecting to the application server.

Unused if LOCATOR-TYPE is InternetServer.
APPSERVER-PASSWORD Character Password for connecting to the application server.

Unused if LOCATOR-TYPE is InternetServer.
APPSERVER-USERID Character User ID for connecting to the application server.

Unused if LOCATOR-TYPE is InternetServer.
KEEP-SECURITY-CACHE Logical If TRUE, WebClient saves the security-cache attributes and this attribute, restoring them the next time the end user reruns the application.

The default is FALSE. Set to TRUE if the end user sets the Save Authentication Information for Future Use toggle box.

Can also be set to TRUE by the application, depending on the security dialog used.The application might set this before WebClient does. For more information, see the Implementing single sign-on.

Note: The PERSISTENT-CACHE-DISABLED attribute must be FALSE to use this attribute.
URL-PASSWORD Character Password for accessing the server.

If LOCATOR-TYPE is InternetServer, the password is for accessing a codebase on an Internet-based server.

If LOCATOR-TYPE is AppServer, the password is for accessing the adapter for a codebase on an application server.

Unused if the URL does not take a password (for example, for a URL of type FILE).
URL-USERID Character User ID for accessing the server.

If LOCATOR-TYPE is InternetServer, the user ID is for accessing a codebase on an Internet-based server.

If LOCATOR-TYPE is AppServer, the user ID is for accessing the adapter for a codebase on an application server.

Unused if the URL does not take a user ID (for example, for a URL of type FILE).

Additional attribute

The following table lists an additional attribute of the CODEBASE-LOCATOR handle.

Table 3. Additional attribute of the CODEBASE-LOCATOR handle
Name Data type Description
SERVER Handle Handle to the application server that WebClient should use to perform the next application-component download. Initialized to the Unknown value (?).

At startup, WebClient initializes SERVER to the Unknown value (?).

The main purpose of this is to use the same application server connection for accessing business logic as for downloading as-needed components. To do this, the application sets the SERVER attribute once the application server connection is established.

If SERVER is not set by the application, then, after WebClient downloads the first as-needed component, WebClient sets SERVER to the value of the application server's handle if all of the following are true:

  • The server's TYPE is AppServer
  • KEEP-CONNECTION-OPEN is TRUE
  • At least one as-needed component remains to be downloaded