- uses Java accessibility mechanisms.
- runs inside the virtual machine of a Java application, and
- interacts with the application's graphical user interface
The Plug-in is used by:
- SSO Studio - to collect information for application window technical definitions, and by
- Enterprise SSO - to perform sign-on-related operations specified in technical definitions
Two Configuration Methods
Java virtual machines load the Plug-in as an accessibility tool. Its executable code is made available to the virtual machine in one of two ways, depending on the Java environment version.
JAVA_TOOL_OPTIONS - Java versions 9 and higher
The Java environment variable JAVA_TOOL_OPTIONS allows options to be passed to the virtual machine as if they were included in its command line.
With Java versions 9 and higher, the Plug-in libraries are made available to the virtual machine using this variable.
Installed Extensions - Java versions 8 and lower
The Java Installed Extensions mechanism allows the virtual machine to be extended by placing Java libraries in a special folder - by default, the Java lib\ext sub-folder. JAR files placed here are automatically included in the virtual machine.
With Java versions 8 and lower, the Plug-in libraries are installed in this folder.
Installation
The E-SSO Java Plug-in is deployed as an option in the EAM Agent package.
During installation, the Plug-in is configured for each Java environment found on the computer. Each is configured automatically using either the JAVA_TOOL_OPTIONS method or the Installed Extensions method.
If a Java environment is not found automatically during installation, or if a new one is installed later, the Plug-in can be re-configured using the ssojsecfg.exe tool in the Enterprise SSO folder.
ssojsecfg.exe can perform either automatic configuration, as follows:
ssojsecfg.exe /install /all
or configuration for a specific Java environment whose folder is specified on the command line:
ssojsecfg.exe /install ‹path-to-java›
‹path-to-java› is the path to the parent folder of the bin folder which contains java.exe.
Use with Enterprise SSO and SSO Studio
Enterprise SSO and / or SSO Studio should be started before the application in which the Plug-in will be loaded.
This is because:
- At start-up, the Plug-in reads a configuration file wgjpi.data which is updated by Enterprise SSO and by SSO Studio. This file is located in the folder indicated by the current Windows user's LOCALAPPDATA environment variable.
- The JAVA_TOOL_OPTIONS environment variable, if it is required, is set by Enterprise SSO at start-up.
Citrix Published Applications Special Case
When required, Enterprise SSO sets the JAVA_TOOL_OPTIONS environment variable. At start-up, it instructs the Windows shell process explorer.exe to pass the variable to all its new child processes.
In the case of Citrix published applications, the explorer.exe process is not present. In order to ensure that Java applications inherit the variable, it should be set 'manually', either in the environment of the system or of the Windows user.
If the variable is set 'manually', care must be taken to unset it when the Plug-in is removed from the computer. If the variable is present and the Plug-in is not, Java applications will not start.
Files
wgjpi.jar
This library file contains the Plug-in's Java executable code.
When using JAVA_TOOL_OPTIONS, it is installed in the same folder as the Enterprise SSO executable file ssoengine.exe. This is typically C:\Program Files\Evidian\Enterprise Access Management.
When using Installed Extensions, the library is installed in the lib\ext sub-folder of the Java environment.
Note that some Java applications use the java.ext.dirs system property to set a different folder for Installed Extensions. In this case, the library must be installed in the appropriate folder 'manually'.
jaccess.jar
This is a Java accessibility executable library that is required by the Plug-in.
It is installed in the same folder as wgjpi.jar.
When the Plug-in is uninstalled from 'Installed Extensions' environments, this file is not deleted as it may have been installed by a different software package.
wgjpi.properties
This Java properties file contains configuration parameters for the Plug-in.
When using JAVA_TOOL_OPTIONS, it is installed in the same folder as Enterprise SSO.
When using Installed Extensions, it is installed in the lib sub-folder of the Java environment.
accessibility.properties
This is a Java properties file which may be present in the lib sub-folder of the Java environment.
If the file is present, it may contain the parameter assistive_technologies which indicates the names of Java classes the virtual machine will use as accessibility tools.
When JAVA_TOOL_OPTIONS is used, this file is not used. Instead, the parameter is passed to the virtual machine as an option in the environment variable.
In Java environments where the Installed Extensions method is used:
At Plug-in installation:
- If the file is not present, it is created
- If the accessibility parameter is not present, it is added;
- The parameter is set to include the name of the Plug-in's main class - a class which is included in wgjpi.jar;
at uninstallation, the reference to the Plug-in class is removed but the file is not deleted.
wgjpiJava.dll
This is a Windows executable library used by the Java executable code in wgjpi.jar. It is installed in the same folder as Enterprise SSO.
On 64-bit platforms, there is a 32-bit version of this file in the x86 sub-folder. This is used by the Plug-in in 32-bit Java environments.
Note that, in order to use the Plug-in with 32-bit Java environments, the 32-bit Microsoft Visual C++ redistributable package must be installed.
JAVA_TOOL_OPTIONS Environment Variable
The value of this variable is calculated by Enterprise SSO.
It is a space-separated concatenation of the following elements (here the default Enterprise SSO installation folder is used):
- -Xbootclasspath/a:"C:\Program Files\Evidian\Enterprise Access Management\wgjpi.jar;C:\Program Files\Evidian\Enterprise Access Management\jaccess.jar"
This appends the Plug-in library and the Java accessibility library to the list of places from which the virtual machine will load executable classes.
- -Djavax.accessibility.assistive_technologies=com.evidian.wg.jpi.WGJPI
This instructs the virtual machine to load and run the Plug-in's main class as an accessibility tool.
- -Dwgjpi.properties.path="C:\Program Files\Evidian\Enterprise Access Management\wgjpi.properties"
This tells the Plug-in where to find its configuration file.
10.02, 10.03
Comments
0 comments
Please sign in to leave a comment.