Version 3.0 policy agents, including the agentadmin program, require JDK 1.5 or later on the server where you plan to install the agent. Before you install the Tomcat 6.0 version 3.0 agent, set your JAVA_HOME environment variable to point to the JDK installation directory.
Login to the server where you want to install the agent.
Create a directory to unzip the tomcat_v6_agent_3.zip distribution file.
This guide uses Agent-HomeDirectory to represent the directory where you unzip the distribution file.
Download the tomcat_v6_agent_3.zip distribution file from one of the following sites:
Sun Downloads site under Identity Management > Policy Agents: http://www.sun.com/download/index.jsp
OpenSSO project site: https://opensso.dev.java.net/public/use/index.html
The following table shows the files and directories after you unzip the agent distribution file, which are in the following directory:
Agent-HomeDirectory/j2ee_agents/tomcat_v6_agent
Agent-HomeDirectory is where you unzipped the agent distribution file.
File or Directory |
Description |
---|---|
README.txt and license.txt |
Readme and license files |
/bin |
agentadmin and agentadmin.bat programs |
/config |
Template, properties, and XML files |
/data |
license.log file. Do not edit this file. |
/etc |
Agent application (agentapp.war) and related file. For information, see Deploying the Agent Application. |
/installer-logs |
Log files written by the agentadmin or agentadmin.bat program:
|
/lib |
Required JAR files |
/locale |
Required properties files |
/sampleapp |
Policy agent sample application. For information, see Deploying the Java EE Policy Agent Sample Application. |
A password file is an ASCII text file with only one line specifying the password in clear text. By using a password file, you are not forced to expose a password at the command line during the agent installation. When you install the Tomcat 6.0 version 3.0 agent using the agentadmin program, you are prompted to specify paths to following password files:
An agent profile password file is required for both the agentadmin default and custom installation options.
An agent administrator password file is required only if you use the custom installation option and have the agentadmin program automatically create the agent profile in OpenSSO Enterprise server during the installation.
Create an ASCII text file for the agent profile. For example: /tmp/tomcat6agentpw
If you want the agentadmin program to automatically create the agent profile in OpenSSO Enterprise server during the installation, create another password file for the agent administrator. For example: /tmp/agentadminpw
Using a text editor, enter the appropriate password in clear text on the first line in each file.
Secure each password file appropriately, depending on the requirements for your deployment.
The Tomcat 6.0 installation file for Windows (.exe extension) does not install certain scripts and related files required by the Tomcat 6.0 version 3.0 agent. Therefore, after you install the Tomcat 6.0 web container on a Windows system, you must copy the scripts from a Tomcat 6.0 .zip distribution file.
In a directory separate from the Tomcat 6.0 .exe installation, download the Tomcat 6.0 .zip distribution file from http://tomcat.apache.org/.
For example, download apache-tomcat-6.0.18.zip.
Make sure that the CATALINA_HOME environment variable is set to your Tomcat 6.0 .exe installation.
Unzip the Tomcat 6.0 .zip distribution file.
Copy the following files from the unzipped bin directory to the Tomcat 6.0 bin directory (${CATALINA_HOME}\bin):
All .bat scripts
catalina-tasks.xml
.jar files
An agent administrator can manage agents in OpenSSO Enterprise, including:
Agent management: Use the agent administrator to manage agents either in the OpenSSO Enterprise Console or by executing the ssoadm utility.
Agent installation: If you install the agent using the custom installation option (agentadmin --custom-install) and want to have the installation program create the agent profile, specify the agent administrator (and password file) when you are prompted.
Login to OpenSSO Enterprise Administration Console.
Create a new agents administrator group:
Create a new agent administrator user and add the agent administrator user to the agents administrator group:
Click Access Control, realm-name, Subjects, and then User.
Click New and provide the following values:
ID: Name of the agent administrator. For example: agentadminuser
This is the name you will use to login to the OpenSSO Enterprise Console .
First Name (optional), Last Name, and Full Name.
For simplicity, use the same name for each of these values that you specified for ID.
Password (and confirmation)
User Status: Active
Click OK.
Click the new agent administrator name.
On the Edit User page, click Group.
Add the agents administrator group from Available to Selected.
Click Save.
Assign read and write access to the agents administrator group:
Login into the OpenSSO Enterprise Console as the new agent administrator. The only available top-level tab is Access Control. Under realm-name, you will see only the Agents tab and sub tabs.