Federation Guides › Legacy Federation Guide › Review the JVMOptions File Which Creates a JVM

Review the JVMOptions File Which Creates a JVM

The JVMOptions.txt File

The JVMOptions.txt file contains the settings that the Policy Server uses when creating the Java virtual machine that is used to support Federation Web Services. SAML 1.x, SAML 2.0, and WS‑Federation use this file.

During a Policy Server upgrade, the existing JVMOptions.txt file is renamed to JVMOptions.txt.backup. A new JVMOptions.txt file is created.

If the original file included customized parameters, be sure to modify the newly created file to include these customized parameters.

For any Apache-based agents, add the SiteMinder/resources directory to the CLASSPATH in the JVMOptions.txt file, as shown in the following example:

-Djava.class.path=C:/Program Files (x86)/CA/siteminder/resources;

The installed location of this file is:

policy_server_home/config/

Important! If you update the JVMOptions.txt file, restart the Policy Server for the changes to take effect.

Notes:

• In some environments, logging off a system while the Policy Server is running causes the Policy Server service to fail. The failure is the result of a JVM issue. To prevent the failure, add the -Xrs command to its own command line in the JVMOptions.txt file. This java command reduces usage of operating system signals by the Java virtual machine.

  This command is case-sensitive so be sure to capitalize the X.

• If you encounter errors relating to missing classes, modify the classpath directive in this file. For complete information about the settings contained in the JVMOptions.txt file, see your Java documentation. The Java compiler directive java.endorsed.dirs is used in the JVMOptions.txt file to control class loading.