Sun OpenSSO Enterprise Policy Agent 3.0 Guide for JBoss Application Server 4.x/5.x

Installing the JBoss Application Server 4.x/5.x Agent Using the agentadmin Program

The version 3.0 agentadmin program includes these installation options:

Before you install the JBoss Application Server 4.x/5.x agent:

Procedure To Install the JBoss Application Server 4.x/5.x Agent Using the agentadmin Program

  1. Log into the host server where you want to install the agent.

    Important: To install the agent, you must have write permission to the JBoss Application Server instance files and directories.

  2. If the JBoss Application Server instance is running, shut it down.

  3. Change to the following directory:

    PolicyAgent-base/bin

  4. On Solaris and Linux systems, set the permissions for the agentadmin program as follows, if needed:

    # chmod 755 agentadmin

  5. Start the agent installation:

    Default install: # ./agentadmin --install

    or

    Custom install: # ./agentadmin --custom-install

    On Windows systems, run the agentadmin.bat program.

  6. Enter information as requested by the agentadmin program, or accept the default values displayed by the program.

    After you have made your choices, the agentadmin program displays a summary of your responses. For example, for a custom installation:

    -----------------------------------------------
    SUMMARY OF YOUR RESPONSES
    -----------------------------------------------
    
    JBoss Server Config Directory : /opt/jboss-4.2.3.GA/server/default/conf
    JBoss Server Home Directory : /opt/jboss-4.2.3.GA
    OpenSSO server URL : http://opensso-host.example.com:8080/opensso
    Agent URL : http://agent-host.example.com:8090/agentapp
    Agent Profile name : JBossAgentProfile
    Agent Profile Password file name : /tmp/jbossagentpw
    Agent permissions gets added to java permissions policy file : false
  7. Verify your choices and either continue with the installation (selection 1, the default) , or make any necessary changes.

    If you continue, the program installs the agent and displays a summary of the installation. For example, for a custom installation:

    SUMMARY OF AGENT INSTALLATION
    -----------------------------
    Agent instance name: Agent_001
    Agent Bootstrap file location:
    /agents/j2ee_agents/jboss_v42_agent/Agent_001/config/OpenSSOAgentBootstrap.properties
    Agent Configuration file location
    /agents/j2ee_agents/jboss_v42_agent/Agent_001/config/OpenSSOAgentConfiguration.properties
    Agent Audit directory location:
    /agents/j2ee_agents/jboss_v42_agent/Agent_001/logs/audit
    Agent Debug directory location:
    /agents/j2ee_agents/jboss_v42_agent/Agent_001/logs/debug
    Install log file location:
    /agents/j2ee_agents/jboss_v42_agent/installer-logs/audit/install.log
  8. After the installation finishes successfully, if you wish, check the installation logs in the following directory:

    installer-logs/audit

  9. Start the JBoss Application Server instance.


Example 1 Sample agentadmin Program Installation for the JBoss Application Server 4.x/5.x Agent

************************************************************************
Welcome to the OpenSSO Policy Agent for JBoss Server 4.x.
************************************************************************
Enter the complete path to the directory which is used by JBoss Server to store
its configuration Files. This directory uniquely identifies the JBoss
Server instance that is secured by this Agent.
[ ? : Help, ! : Exit ]
Enter the JBoss Server Config Directory Path
[/opt/jboss-4.2.3/server/default/conf]: /opt/jboss-4.2.3.GA/server/default/conf

Enter the complete path to the directory where JBoss Server home directory is
stored
[ ? : Help, < : Back, ! : Exit ]
Enter the JBoss Server Home Directory Path
[/opt/jboss-4.2.3.GA]: /opt/jboss-4.2.3.GA

Enter the URL where the OpenSSO server is running. Please include the
deployment URI also as shown below:
(http://opensso.sample.com:58080/opensso)
[ ? : Help, < : Back, ! : Exit ]
OpenSSO server URL: http://opensso-host.example.com:8080/opensso

Enter the Agent URL. Please include the deployment URI also as shown below:
(http://agent1.sample.com:1234/agentapp)
[ ? : Help, < : Back, ! : Exit ]
Agent URL: http://agent-host.example.com:8090/agentapp

Enter the Agent profile name
[ ? : Help, < : Back, ! : Exit ]
Enter the Agent Profile name: JBossAgentProfile

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/jbossagentpw

Indicate the specified server instance runs with Java security manager
permissions.
[ ? : Help, < : Back, ! : Exit ]
Specify whether the chosen server instance runs with Java security manager
permissions. [false]: false

-----------------------------------------------
SUMMARY OF YOUR RESPONSES
-----------------------------------------------
JBoss Server Config Directory :
/opt/jboss-4.2.3.GA/server/default/conf
JBoss Server Home Directory : /opt/jboss-4.2.3.GA
OpenSSO server URL : http://opensso-host.example.com:8080/opensso
Agent URL : http://agent-host.example.com:8090/agentapp
Agent Profile name : JBossAgentProfile
Agent Profile Password file name : /tmp/jbossagentpw
Agent permissions gets added to java permissions policy file : false
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]: 1
Creating directory layout and configuring Agent file for Agent_001 instance ...DONE.
Reading data from file
/tmp/jbossagentpw and
encrypting it ...DONE.
Generating audit log file name ...DONE.
Creating tag swapped OpenSSOAgentBootstrap.properties file for instance
Agent_001 ...DONE.
Creating a backup for file
/opt/jboss-4.2.3.GA/server/default/conf/jboss-service.xml
...DONE.
Adding Agent parameters to
/opt/jboss-4.2.3.GA/server/default/conf/jboss-service.xml
file ...DONE.
Creating a backup for file null ...DONE.
Adding Agent parameters to null file ...DONE.
Adding Agent parameters to am-login-config.xml file ...DONE.
Adding Agent parameters to
/opt/jboss-4.2.3.GA/bin/setAgentClasspathdefault.sh
file ...DONE.
Adding Agent parameters to agentapp.war file ...DONE.

SUMMARY OF AGENT INSTALLATION
-----------------------------
Agent instance name: Agent_001
Agent Bootstrap file location:
/agents/j2ee_agents/jboss_v42_agent/Agent_001/config/OpenSSOAgentBootstrap.properties
Agent Configuration file location
/agents/j2ee_agents/jboss_v42_agent/Agent_001/config/OpenSSOAgentConfiguration.properties
Agent Audit directory location:
/agents/j2ee_agents/jboss_v42_agent/Agent_001/logs/audit
Agent Debug directory location:
/agents/j2ee_agents/jboss_v42_agent/Agent_001/logs/debug

Install log file location:
/agents/j2ee_agents/jboss_v42_agent/installer-logs/audit/install.log

Thank you for using OpenSSO Policy Agent 3.0.

After You Finish the Install

Agent Instance Directory

The installation program creates the following directory for each agent instance:

PolicyAgent-base/Agent_nnn

Each agent instance directory contains the following subdirectories: