Installing the CallAPI for Java

The Automation Engine supplies a CallAPI for Java. It enables calls in the Automation Engine from your own programs, but can also be used through the command line or a batch file.

To install the CallAPI for Java, you need to set up the system environment and adjust the INI file (ucxbjxxc.ini) of the Java CallAPI accordingly, see Call API Java INI file.

Notes:

• The Call API can be used without having to install it, as the relevant files are installed when the corresponding agent is installed.
• You can keep your existing INI file even if there is a new Automation Engine version and adjust it as required.

Important! The communication between the Java Communication Process (JCP) and the Proxy uses TLS/SSL exclusively. Because the CallAPI does not natively support TLS/SSL and still connects to the Communication Process (CP), it cannot connect directly to the Proxy nor the JCP). However, you can route CallAPI connections through the TLS Gateway to secure them. For more information, see TLS Gateway. The exceptions are the Java and SAP CallAPIs which already use TLS/SSL to connect to the Automation Engine. They communicate directly with the JCP and use trusted certificates to authenticate their identity to other communication partners.

More information:

• Securing Connections to the AE (TLS/SSL)

• TLS/SSL Certificate Considerations

• Types of Server Processes

For additional information about the different certificate types and examples of how they could be created and used, see What Kind of Certificates Should I Use for Automic Automation v21.

Important! Please note that these are only examples, not a requirement for Automic Automation and they are not meant to replace the product documentation.

In Automic Automation Kubernetes Edition, CallAPIs establish a connection to a TCP load balancer. The address of this load balancer must be configured on both ends—the Automation Engine and the CallAPI. The only exceptions are the Java and SAP CallAPIs, which must be updated to use TLS/SSL when connecting to the Automation Engine. These two CallAPIs establish a direct connection to the Java Communication Process (JCP) through an HTTPS load balancer. In this setup, you can also route the connections of the other CallAPIs through the TLS Gateway to securely reach the HTTPS load balancer.

More information:

• Container-Based Installation - Automic Automation Kubernetes Edition

• Connecting to the AAKE Cluster

See also:

• Platforms for CallAPIs
• Installing the Agent for Java EE/JMX (Standalone)
• Installing the Agent for Java EE/JMX (Application Server)