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

Gathering Information to Install the JBoss Application Server 4.x/5.x Agent

The following table describes the information you will need to provide when you run the agentadmin program to install the JBoss Application Server 4.x/5.x agent. For some agentadmin prompts, you can accept the default value displayed by the program, if you prefer.

Note. The examples and sample runs in this guide refer to JBoss AS 4.x; however, JBoss 5.x is also supported.

Table 2 Information Required to Install the JBoss Application Server 4.x/5.x Agent

Prompt 

Description 

Config Directory Path 

Path to the configuration directory for the JBoss Application Server instance. 

Applies to both default and custom installation options. 

For example: /opt/jboss-4.2.3.GA/server/default/conf

Home Directory Path 

Path to the JBoss Application Server home directory. 

Applies to both default and custom installation options. 

For example: /opt/jboss-4.2.3.GA

OpenSSO server URL 

OpenSSO Enterprise server URL, including the deployment URI. 

Applies to both default and custom installation options. 

For example: http://opensso-host.example.com:8080/opensso

Agent URL 

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

Applies to both default and custom installation options. 

For example: http://agent-host.example.com:8090/agentapp

The agent application (agentapp.war) is a housekeeping application used by the agent for notifications and other functions such as cross-domain single sign-on (CDSSO). For 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. 

Option to add Java security permissions to the JBoss Application Server security policy file 

Indicates whether the JBoss Application Server instance runs with the Java Security Manager enabled and you want the installer to add the Java security permissions to the security policy file. 

  • true — The installer adds the Java security permissions to the JBoss Application Server security policy file.

    The installer first displays the server.policy file in the configuration directory. If the JBoss Application Server instance is using a different serve policy file, specify the path to that file.

  • false (default) — The installer does not add Java security permissions to the security policy file.

Applies only to the default installation option.