Installing the Agent for Java EE/JMX (JBoss)

The following guide describes how to install an agent in an AE system in which authentication is not used. Additional installation steps are required before the agent can be started and used if you intend to use one of the available authentication methods. For more information, see Agent Authentication.

Installing the Agent for Java EE/JMX (JBoss)

  1. Set up the JMX agent.

    • Host
    • Copy the file ucxjjmx.war to a folder and use an appropriate program to unpack it.
    • Then, in the configuration file web.xml, adjust the following two parameters:

    <load-on-startup> - Ensure that the value is always set to 1. Otherwise, the agent is not loaded and cannot be started.

      <run-as><role-name> - Adjust this parameter if you intend to use roles. The role must then be defined (or deleted) in the security section (<security-role>).

    • Rename the folder in which the agent files are stored. The name must end with the string ".war".

    A sample folder name: ucxjjmx.war

    • Move the folder to the JBoss Deploy directory. The agent is automatically deployed and the following message is displayed:

      445 INFO  [TomcatDeployer] deploy, ctxPath=/ucxjjmx, warUrl=file:/C:/jboss-3.2.7/server/default/deploy/ucxjjmx.war/

  2. Use the web configuration interface.

    • Host

    • The JMX agent has a configuration web interface that can be called with a Web browser using the following address:

      http://Server name:port/context root

      For more information, see Web Configuration Interface for the Java EE/JMX Agent.

      The sample address uses the string ucxjjmxbecause that is the string used in the sample folder name, before the file extension (.war):ucxjjmx. If you chose a different name, use that name instead.

    • Adjust the settings of the JMX agent to suit your system environment. The most important settings are:
      • Name of the agent
      • Name of the computer on which a communication process is available
      • Port number of a communication process

    Note: the configuration file will be overwritten when you deploy the WAR file again. As a result you will have to redefine your configuration settings. Instead, you can also save a copy of your configuration file (INI file) before you start the deployment and copy it to the folder that includes the web application after the deployment has taken place.

  3. Important notes for creating jobs:

    • Host
    • Select the option "Local Java VM" in the Job object's JMX tab.
    • Activate the sub-menu "Use existing MB Server".
    • It is not necessary to select the option "Generate new instance..."