Sun OpenSSO Enterprise Policy Agent 3.0 Guide for Apache Tomcat 6.0

Gathering Information to Install the Tomcat 6.0 Version 3.0 Agent

The following table describes the information you will need to provide when you run the agentadmin program to install the Tomcat 6.0 version 3.0 agent. For some agentadmin prompts, you can accept the default value displayed by the program, if you prefer.

Table 1 Information Required to Install the Tomcat 6.0 version 3.0 Agent

Prompt 

Description 

Tomcat Server Config Directory Path 

Path to the configuration directory for the Tomcat 6.0 instance. 

Applies to both default and custom installation options. 

For example: /opt/apache-tomcat-6.0.18/conf

OpenSSO server URL 

OpenSSO Enterprise server URL, including the deployment URI. 

Applies to both default and custom installation options. 

For example: https://openssohost.example.com:8080/opensso

$CATALINA_HOME environment variable

Path to the root directory where Tomcat 6.0 is installed. 

For example: /opt/apache-tomcat-6.0.18/

Install policy agent in global web.xml file

Option to install the agent filter in the global web.xml file:

  • true (default): The agent filter is added to the global web xml file ($CATALINA_HOME/conf/web.xml). Then, every request is intercepted by the agent, so the policy definition needs to reflect the Tomcat 6.0 root URL to access the home page.

  • false: The agent filter is not added to the application-specific web.xml file.

In both cases, agent filter are added to the manager and host manager and applications. 

See also Adding Absolute URIs to the Tomcat 6.0 Version 3.0 Agent Profile.

Applies to the default installation option. 

Agent URL 

Agent URL, including the deployment URI, for the agent application. 

Applies to both default and custom installation options. 

For example: https://agenthost.example.com:8090/agentapp

The agentapp is a housekeeping application used by the agent for notifications and other functions such as cross domain single sign-on (CDSSO) support. For more information, see Deploying the Agent Application.

Encryption Key 

Key used to encrypt the agent profile password. The encryption key should be at least 12 characters long. You can accept the default key or create a new key using the agentadmin --getEncryptKey command.

Applies only to the custom installation option. 

Agent profile name 

A policy agent communicates with OpenSSO Enterprise using the name and password in the agent profile. 

Applies to both default and custom installation options. 

For information, see Creating an Agent Profile.

Agent profile password file name 

Path to the agent profile password file, which is ASCII text file with only one line specifying the agent profile password. You create the agent profile password file as a pre-installation step. 

Applies to both default and custom installation options. 

For information, see Creating a Password File.

Option to the create the agent profile 

The agentadmin program displays the following prompt if the agent profile previously specified for the Agent Profile Name prompt does not already exist in OpenSSO Enterprise:

Enter true if the Agent Profile is being created into OpenSSO by the installer. Enter false if it will be not be created by installer.

To have the installation program create the agent profile, enter true. The program then prompts you for:

  • Agent administrator who can create, update, or delete the agent profile. For example: agentadmin

    Important: To use this option, the agent administrator must already exist in OpenSSO Enterprise server. For information see, Creating an Agent Administrator.

    If you prefer, you can specify amadmin as this user.

  • Path to the agent administrator password file. For information, see Creating a Password File.

Applies only to the custom installation option.