Sun Java System Access Manager Policy Agent 2.2 Guide for JBoss Application Server 4.0

JBoss Application Server 4.0 Agent Installation Functions

The agentadmin program performs the following functions during the installation of the agent for JBoss Application Server 4.0:

Deploys the agentapp.war file in the JBoss server instance's /deploy directory. For example:
```
/opt/jboss-4.0.2/server/default/deploy/agentapp.war
```
Copies the am-login-config-service.xml file to the JBoss server instance's /deploy directory. For example:
```
/opt/jboss-4.0.2/server/default/deploy/am-login-config-service.xml
```
Copies the am-login-config.xml file to the JBoss server instance's /conf directory. For example:
```
/opt/jboss-4.0.2/server/default/conf/am-login-config.xml
```
Copies the setAgentClasspath script file pertaining to the JBoss server instance to the JBOSS_HOME/bin directory. This script sets JBOSS_CLASSPATH with the agent's /config and /locale directories. For example:
```
/opt/jboss-4.0.2/bin/setAgentClasspathdefault.sh
```
Where default indicates the JBoss server instance name. For example, if the server instance name is jbserver, then the script file name will be setAgentClasspathjbserver.sh. On Windows systems, the file extension for the script is .bat.

Modifies the jboss-service.xml file in the JBoss server's instance. These changes load the agent.jar and amclientsdk.jar files. For example:

<classpath codebase="/opt/j2ee_agents/am_jboss_agent/lib" 
          archives="agent.jar"/>
<classpath codebase="/opt/j2ee_agents/am_jboss_agent/lib" 
          archives="amclientsdk.jar"/>

Optionally, based on your selection, if JBoss server is running with Java permissions, modifies the server.policy file in the /conf directory by adding Java permissions to the agent code base. For example:

grant codeBase "file:/opt/j2ee_agents/am_jboss_agent/lib/-" {
permission java.lang.RuntimePermission "accessClassInPackage.org.apache.*";
permission java.lang.RuntimePermission "getClassLoader";
permission java.lang.RuntimePermission "shutdownHooks";
permission java.io.FilePermission "/opt/j2ee_agents/am_jboss_agent/agent_001/config/-", "read";
permission java.util.PropertyPermission "*", "read,write";
permission java.io.FilePermission "/opt/j2ee_agents/am_jboss_agent/locale/-", "read";
permission java.io.FilePermission "/opt/j2ee_agents/am_jboss_agent/agent_001/logs/-",
"read,write";
permission java.net.SocketPermission "*", "connect,resolve";
permission java.util.logging.LoggingPermission "control";
permission java.io.FilePermission "null/serverconfig.xml", "read";
};

Preparing to Install Agent for JBoss Application Server 4.0

Detailed information about unpacking the distribution files for J2EE agents in Policy Agent 2.2 is covered in Chapter 2, Vital Installation Information for a J2EE Agent in Policy Agent 2.2. The best practice is to follow the detailed steps outlined in that chapter before you implement any steps outlined in this chapter.

The following examples provide quick details about the unpacking process. Furthermore, this section provides the opportunity to present again the cautionary note that follows about the GNU_tar program.

Caution –

For .tar.gz archives, do not use a program other than GNU_tar to untar the contents of the J2EE agent deliverables. Using a different program, such as another tar program, can result in some files not being extracted properly. To learn more about the GNU_tar program, visit the following web site:

http://www.gnu.org/software/tar/tar.html

Example 3–1 Format of the Distribution Files of Agent for JBoss Application Server 4.0

SJS_JBoss_4.0_Server_agent_2.2.tar.gz
SJS_JBoss_4.0_Server_agent_2.2.zip
SJS_JBoss_4.0_Server_agent_2.2_SUNWamjboss.tar.gz

For detailed information on the format of the distribution files, see Format of the Distribution Files for a J2EE Agent Installation in Policy Agent 2.2.

Example 3–2 Unpacking Non-Package Formatted Deliverables of Agent for JBoss Application Server 4.0

# gzip -dc SJS_JBoss_4.0_Server_agent_2.2.tar.gz | tar xvf -

For detailed information about this command, see To Unpack Non-Package Formatted Deliverables of a J2EE Agent in Policy Agent 2.2.

Example 3–3 Unpacking Package Formatted Deliverables of Agent for JBoss Application Server 4.0

# gzip -dc SJS_JBoss_4.0_Server_agent_2.2_SUNWamjboss.tar.gz | tar xvf -

For detailed information about this command, see To Unpack Package Formatted Deliverables of a J2EE Agent in Policy Agent 2.2.

Example 3–4 Unpacking a `.zip` Compressed file of Agent for JBoss Application Server 4.0

unzip SJS_JBoss_4.0_Server_agent_2.2.zip

For example, if you unzip the file in /opt, the home directory is /opt/j2ee_agents/am_jboss_agent. In this guide, JBOSS_AGENT_HOME represents the home directory.

For detailed information about this command, see To Unpack a .zip Compressed file of a J2EE Agent in Policy Agent 2.2.

Follow the specific steps outlined in the following section before you install the agent to reduce the chance of complications occurring during and after the installation.

To Prepare to Install the Agent for JBoss Application Server 4.0:

Ensure that the Policy Agent 2.2 for JBoss Application Server 4.0 is supported on the desired platform as listed in Supported Platforms and Compatibility of Agent for JBoss Application Server 4.0.

Install JBoss Application Server 4.0 if it is not already installed.

Refer to the appropriate JBoss Application Server 4.0 installation documentation for information about installing this product on the following web site:

http://www.jboss.com/downloads/index.

Note –
The Agent for JBoss Application Server 4.0 is not supported with the JBoss minimal configuration set.

Ensure that the JBoss Application Server 4.0 instance that will be protected by the agent is shut down.

Create a valid agent profile in Access Manager Console if one has not already been created.

For information on how to create an agent profile, see Creating a J2EE Agent Profile.

To avoid a misconfiguration of the agent, ensure that you know the exact ID and password used to create the agent profile. You must enter the agent profile password correctly in the next step and you must enter the agent profile ID correctly when installing the agent.

Create a text file and add the agent profile password to that file.

Ensure that this file is located in a secure directory of your choice. You will refer to this file during the agent installation process.

With the agent profile password in this file, stored in a secure location, you do not need to enter sensitive information in the console. A valid password file can have only one line that contains the agent profile password.

Using the Installation Program of Agent for JBoss Application Server 4.0

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 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 JBoss Application Server 4.0

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.

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.