Overview

When JADE is installed under the \Program Files directory, it conforms to the expected Windows behavior.

The ability to return locations other than the JADE HOME directory for program and user data requests is dependent on where the JADE binaries have been installed.

If the JADE programs are not installed in the system-wide location for installed applications (in a folder in the Program Files directory), returning alternative addresses is not implemented. It is assumed that the programs installed in custom locations have sufficient security privileges to work in the style of earlier JADE 6.3 releases.

Although the alternative names and locations are driven by Windows requirements, the code is portable across Windows implementations.

The Node and Process class methods summarized in this section provide access to various locations in the file system hierarchy, because security restrictions can deny appropriate access to previously available directories or the directories are a unique location for each user when they were previously shared. (For details about the differences of these methods called on nodes and processes, see "Directory Locations", in Chapter 2 of the JADE Installation and Configuration Guide.)

Method Returns a string containing the …
getJadeInstallDirectory Directory in which the executable of the current executing program is located.
getJadeHomeDirectory Parent directory of the installation directory.
getProgramDataDirectory Program data directory, which is dependent on the value of the ProgramDataDirectory parameter in the [JadeEnvironment] section of the JADE initialization file and the location of the installation directory.
  Files that should be placed under the returned location are entities that should be shared across multiple users of these binaries; for example, the jommsg.log file or shared dictionary spelling files that are updated.
getUserDataDirectory User data directory, which is dependent on the value of the UserDataDirectory parameter in the [JadeEnvironment] section of the JADE initialization file and the location of the installation directory.
  Files that should not be placed under the returned location are entities that should be shared across multiple users of these binaries; for example, if a presentation client installation occurs on a Windows machine running Citrix or Terminal Services and all users run the same thin client binaries, any data created on the client file system should be stored under this location (that is, dictionaries for each user).
getJadeWorkDirectory Directory in which the JADE work files are created and which is dependent on the value of the JadeWorkDirectory parameter in the [JadeEnvironment] section of the JADE initialization file.

Returned directory strings are normalized; that is, they have the virgule, or forward slash, (/) character as directory separators and they end in the virgule (/) character. Directories are created if they do not exist.

For details about the JADE HOME directory, see "Specifying Arguments in the JADE Command Line", in Chapter 2 of the JADE Installation and Configuration Guide.

For more details, see "Directory Locations", in Chapter 2 of the JADE Installation and Configuration Guide, Volume 1 and Volume 2 of the JADE Encyclopaedia of Classes, and "JADE Environment [JadeEnvironment] Section", in the JADE Initialization File Reference.