Installing the Agent for Java EE/JMX (JBoss)

This page guides you through the installation of 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.

Tip! This page refers only to the manual installation process. If you want instructions on how to install a containerized Java agent, see Installing Containerized Java Agents.

This page includes the following:

Connecting to the Automation Engine

The Automation Engine and the Windows, UNIX, and Java Agents communicate using TLS/SSL. These agents establish a connection with the Java communication process (JCP), which uses trusted certificates to prove their identity to other communication partners.

Important! Make sure you are familiar with the TLS/SSL and certificate implementation before installing and/or upgrading the respective component. For more information, see:

When you used certificates signed by a CA, the certificates are stored in the respective Java or OS store by default; that is the Java trust store for Java components and Java Agents, the Windows OS store for Windows Agents, or the TLS/SSL store for UNIX Agents. In this case, you only have to check that the root certificates already are in the respective store.

If the relevant certificates are not there and you want to import them, you can use OS or Java specific tools for that purpose, such as Keytool, cert-manager, OpenSSL and such. For more information on how to use those tools, please refer to the respective product documentation.

If you do not want to use the default locations for the components and Agents listed above, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

Important! TLS/SSL Agents (in containers and on-premises) as well as the TLS Gateway, when used for the Automic Automation Kubernetes Edition, establish a connection to an ingress / HTTPS load balancer, which requires a certificate for authentication.

Make sure that address of the load balancer is defined on both sides: the Automation Engine and the Agent / TLS Gateway and that your HTTPS load balancer has the required certificates in place. For more information, see Connecting to AWI, the JCP and REST Processes Using an Ingress.

Installing the Agent for Java EE/JMX (JBoss)

  1. On the host, set up the Agent.

    • Copy the ucxjjmx.war to a folder and unpack it.

    • In the web.xml configuration file, adjust the following parameters:

      • <load-on-startup> - 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 .war extension, for example, 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. On the host, use the configuration WebInterface .

    • 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 ucxjjmx because that is the string used in the sample folder name, before the file .war extension. If you chose a different name, use that name instead.

    • Adjust the JMX agent settings to your system environment. The most important settings are:

      • Name of the agent

      • Name of the computer on which the Java communication process is available

      • Port number of the Java 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.

    • When you used certificates signed by a CA, the certificates are stored in the respective Java or OS store by default. In this case, you only have to check that the root certificates already are in the respective store.

      If you do not want to use the default location for this component, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

      For more information, see Securing Connections to the AE (TLS/SSL).

  3. On the host, before creating jobs, consider the following issues:

    • Select 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...

See also: