Sun Java System Access Manager Policy Agent 2.2 Guide for Oracle Application Server 10g

Previous: Launching the Installation Program of Agent for Oracle Application Server 10g
Next: Chapter 4 Post-Installation Tasks of Policy Agent 2.2 for Oracle Application Server 10g

Using the Installation Program of Agent for Oracle Application Server 10g

After you issue the agentadmin command and accept the license agreement (if necessary) the installation program appears, prompting you for information.

The steps in the installation program are displayed in this section in an example interaction. Your answers to prompts can differ slightly or greatly from this example depending upon your specific deployment. In the example, most of the defaults have been accepted. This example is provided for your reference and does not necessarily indicate the precise information you should enter.

The following bulleted list provides key points about the installation program.

Each step in the installation program includes an explanation that is followed by a more succinct prompt.
For most of the steps you can type any of the following characters to get the results described:

?

Type the question mark to display Help information for that specific step.

<

Type the left arrow symbol to go back to the previous interaction.

!

Type the exclamation point to exit the program.
Most of the steps provide a default value that can be accepted or replaced. If a default value is correct for your site, accept it. If it is not correct, enter the correct value.

About Installation Prompts in Agent for Oracle Application Server 10g

The following list provides information about specific prompts in the installation. Often the prompt is self explanatory. However, at other times you might find the extra information presented here to be very helpful. This extra information is often not obvious. Study this section carefully before issuing the agentadmin --install command.

The Deployment URI for the Agent Application

The deployment URI for the agent application is required for the agent to perform necessary housekeeping tasks such as registering policy and session notifications, legacy browser support, and CDSSO support. Accept /agentapp as the default value for this interaction. Once the installation is completed, browse the directory PolicyAgent-base/etc. Use the agentapp.war file to deploy the agent application in the application container. Please note that the deployment URI for agent application during install time should match the deployment URI for the same application when deployed in the J2EE container.

The port number of Application Server

The port number referred to in this prompt is not the OC4J port number, but the Apache server port. The default port number is 7777 on UNIX-based systems and 80 on Windows systems.

Caution –

Pay attention to the port number being requested by the following prompt: Enter the preferred port number on which the application server provides its services. Entering the OC4J port number results in a misconfiguration.

The Encryption Key

This key is used to encrypt sensitive information such the passwords. The key should be at least 12 characters long. A key is generated randomly and provided as the default. You can accept the random key generated by the installer or create your own using the .agentadmin --getEncryptKey command.

For information about creating a new encryption key, see agentadmin --getEncryptKey.

The Agent Profile Name

An agent profile should have been created as a pre-installation step. The creation of the agent profile is mentioned in that section. For the pre-installation steps, see Preparing to Install Agent for Oracle Application Server 10g. For the actual information on creating an agent profile, see Creating a J2EE Agent Profile.

In summary, the J2EE agent communicates with Access Manager with a specific ID and password created through an agent profile using Access Manager Console. For J2EE agents, the creation of an agent profile is mandatory. Access Manager uses the agent profile to authenticate an agent. This is part of the security infrastructure.

The J2EE Password File

The J2EE password file should have been created as a pre-installation step. For the pre-installation steps, see Preparing to Install Agent for Oracle Application Server 10g.

When the installation program prompts you for the password for the agent, enter the fully qualified path to this password file.

After you have completed all the steps, a summary of your responses appears followed by options that allow you to navigate through those responses to accept or reject them.

When the summary appears, note the agent instance name, such as agent_001. You might be prompted for this name during the configuration process.

About the options, the default option is 1, Continue with Installation.

If you are satisfied with the summary, choose 1 (the default).
If you want to edit input from the last interaction, choose 2.
If you want to edit input starting at the beginning of the installation program, choose 3.
If you want to exit the installation program without installing, choose 4.

You can edit your responses as necessary, return to the options list, and choose option 1 to finally process your responses.

Example of Installation Program Interaction in Agent for Oracle Application Server 10g

The following example is a sample installation snapshot of Policy Agent 2.2 for Oracle Application Server 10g. By no means does this sample represent a real deployment scenario.

The section following this example, Implications of Specific Deployment Scenarios in Agent for Oracle Application Server 10g, explains specific deployment scenario involving the installation of multiple J2EE agent instances. If such a scenario applies to your deployment, review that section before proceeding with the installation.

Caution –

Though the information in this note has already been presented in this guide, it is being repeated because of its importance. During the installation of this agent, pay attention to the port number being requested with the following prompt: Enter the preferred port number on which the application server provides its services. Entering the OC4J port number results in a misconfiguration. Instead, enter the Apache server port number. By default, this port number is 7777 on UNIX-based systems and 80 on Windows systems.

************************************************************************
Welcome to the Access Manager Policy Agent for Oracle10g 10.1.2. If the
Policy Agent is used with Federation Manager services, User needs to enter
information relevant to Federation Manager.
************************************************************************
Enter the complete path to the directory which is used by Oracle10g OC4J to
store its configuration Files. This directory uniquely identifies the
Oracle10g OC4J instance that is secured by this Agent.
[ ? : Help, ! : Exit ]
Enter the Oracle10g OC4J Config Directory Path
[/opt/oracle/OraHome_1012/j2ee/home/config]: /opt/oracle/OraJ2EE_1012/j2ee/home/
config

Enter the name of the global application.xml
[ ? : Help, < : Back, ! : Exit ]
Enter the name of the global application.xml [application.xml]:
Press Enter

Enter the fully qualified host name of the server where Access Manager
Services are installed.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services Host: host1.subdomain.domain.com

Enter the port number of the Server that runs Access Manager Services.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services port [80]: 58080

Enter http/https to specify the protocol used by the Server that runs Access
Manager services.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services Protocol [http]:
Press Enter

Enter the Deployment URI for Access Manager Services.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services Deployment URI [/amserver]:
Press Enter

Enter the fully qualified host name on which the Application Server
protected by the agent is installed.
[ ? : Help, < : Back, ! : Exit ]
Enter the Agent Host name: host2.subdomain.domain.com

Enter the preferred port number on which the application server provides its
services.
[ ? : Help, < : Back, ! : Exit ]
Enter the port number for Application Server instance [7777]: 7779

Select http or https to specify the protocol used by the Application server
instance that will be protected by Access Manager Policy Agent.
[ ? : Help, < : Back, ! : Exit ]
Enter the Preferred Protocol for Application Server instance [http]:
Press Enter

Enter the deployment URI for the Agent Application. This Application is used
by the agent for internal housekeeping.
[ ? : Help, < : Back, ! : Exit ]
Enter the Deployment URI for the Agent Application [/agentapp]:
Press Enter

Enter a valid Encryption Key.
[ ? : Help, < : Back, ! : Exit ]
Enter the Encryption Key [Nh7wAmL8/XJks33/npM6SwoinIL8Vk0a]:
Press Enter

Enter a valid Agent profile name. Before proceeding with the agent
installation, please ensure that a valid Agent profile exists in Access
Manager.
[ ? : Help, < : Back, ! : Exit ]
Enter the Agent Profile name: agent1

Enter the path to a file that contains the password to be used for identifying
the Agent.
[ ? : Help, < : Back, ! : Exit ]
Enter the path to the password file: /tmp/password.txt


*********************************************************
SUMMARY OR YOUR RESPONSES
*********************************************************
Oracle10g OC4J instance Config Directory :
/opt/oracle/OraJ2EE_1012/j2ee/home/config
Oracle10g OC4J instance-level application.xml : application.xml
Access Manager Services Host : host1.subdomain.domain.com
Access Manager Services Port : 58080
Access Manager Services Protocol : http
Access Manager Services Deployment URI : /amserver
Agent Host name : host2.subdomain.domain.com
Application Server Instance Port number : 7779
Protocol for Application Server instance : http
Deployment URI for the Agent Application : /agentapp
Encryption Key : Nh7wAmL8/XJks33/npM6SwoinIL8Vk0a
Agent Profile name : agent1
Agent Profile Password file name : /tmp/password.txt

Verify your settings above and decide from the choices below.
1. Continue with Installation
2. Back to the last interaction
3. Start Over
4. Exit
Please make your selection [1]

Agent Version and Property Configuration: Agent for Oracle Application Server 10g

The instructions presented in this section related to editing the J2EE agent AMAgent.properties configuration file are required for the initial version of Agent for Oracle Application Server 10g. Updated versions of the agent do not require the performance of these configuration instructions. Starting with Policy Agent 2.2 hot patch 4, the configuration instructions presented in this section should not be performed. If you are not certain of the version of this agent, perform the following task about checking the agent version.

To Check the Specific Version of Agent for Oracle Application Server 10g

Issue the following command:
./agentadmin --version

Next Steps

The preceding command results in the agent issuing version information. If the version indicated is a version prior to hot patch 4, then perform the task that follows. If the version is hot patch 4 or greater, skip the task that follows.

(Conditional) To Configure the J2EE agent `AMAgent.properties` Configuration File

Using the text editor of your choice, access the J2EE agent AMAgent.properties configuration file.

Edit the following property as such:
java.util.logging.config.file = PolicyAgent-base/config/AMAgentLogConfig.properties
The property was originally set as follows:
java.util.logging.config.file = PolicyAgent-base/agent_001/config/AMAgentLogConfig.properties
where agent_001 serves as an example that might be different in your situation depending upon the number of agents that have been installed on the machine.

Editing the value for this property involves the removal of the following string “agent_001/”

Add the following property and value to the bottom of the configuration file:

com.sun.identity.agents.config.composite.advice.file = PolicyAgent-base/locale/CompositeAdviceForm.txt

Save and close the updated J2EE agent AMAgent.properties configuration file.

Implications of Specific Deployment Scenarios in Agent for Oracle Application Server 10g

The following section refers to a specific deployment scenario involving multiple instances of Policy Agent 2.2 for Oracle Application Server 10g.

Installing a J2EE Agent on Multiple Oracle Application Server 10g Instances

Once a J2EE agent is installed for a particular Oracle Application Server 10g instance, you can install the agent on another instance on the same machine by running the agentadmin --install command.

Summary of a J2EE Agent Installation in Policy Agent 2.2

At the end of the installation process, the installation program prints the status of the installation along with the installed J2EE agent information. The information that the program displays can be very useful. For example, the program displays the agent instance name, which is required when configuring a remote instance. The program also displays the location of specific files, which can be of great importance. In fact, you might want to view the installation log file once the installation is complete, before performing the post-installation steps as described in Chapter 4, Post-Installation Tasks of Policy Agent 2.2 for Oracle Application Server 10g.

The location of directories displayed by the installer are specific. However, throughout this guide and specifically in Summary of Agent Installation shown in this section, PolicyAgent-base is used to describe the directory where the distribution files are stored for a specific J2EE agent.

The following example serves as a quick description of the location of the J2EE agent base directory (PolicyAgent-base) of Policy Agent 2.2 for Oracle Application Server 10g.

Example 3–5 Policy Agent Base Directory of Agent for Oracle Application Server 10g

The following directory represents PolicyAgent-base of Agent for Oracle Application Server 10g:

Agent-HomeDirectory/j2ee_agents/am_oracle_1012_agent

where Agent-HomeDirectory is the directory you choose in which to unpack the J2EE agent binaries.

Information regarding the location of the J2EE agent base directory is explained in detail in Location of the J2EE Agent Base Directory in Policy Agent 2.2.

The following type of information is printed by the installer:

SUMMARY OF AGENT INSTALLATION
-----------------------------
Agent instance name: agent_001
Agent Configuration file location:
PolicyAgent-base/agent_001/config/AMAgent.properties
Agent Audit directory location:
PolicyAgent-base/agent_001/logs/audit
Agent Debug directory location:
PolicyAgent-base/agent_001/logs/debug

Install log file location:
PolicyAgent-base/logs/audit/install.log

Thank you for using Access Manager Policy Agent

Once the agent is installed, the directories shown in the preceding example are created in the agent_00x directory, which for this example is specifically agent_001. Those directories and files are briefly described in the following paragraphs.

PolicyAgent-base/agent_001/config/AMAgent.properties

Location of the J2EE agent AMAgent.properties configuration file for the agent instance. Every instance of a J2EE agent has a unique copy of this file. You can configure this file to meet your site's requirements. For more information, see the following sections:

PolicyAgent-base/agent_001/logs/audit

Location of the J2EE agent local audit trail.

PolicyAgent-base/agent_001/logs/debug

Location of all debug files required to debug an agent installation or configuration issue.

PolicyAgent-base/logs/audit/install.log

Location of the file that has the agent install file location. If the installation failed for any reason, you can look at this file to diagnose the issue.