The RPC Server for XML/SOAP allows RPC clients to communicate with target servers via HTTP(S). The RPC Server for XML/SOAP transforms RPC client calls into XML/SOAP calls. It enables standard RPC clients to communicate with XM/SOAP servers. It works together with the XML/SOAP Wrapper.
The RPC Server for XML/SOAP can run in the Software AG Runtime. This document covers the following topics:
See also RPC Server for XML/SOAP in the Software AG Runtime under Frequently Asked Questions (FAQ) and Troubleshooting in the XML/SOAP Wrapper documentation.
The Software AG Common Platform is a Java Runtime environment based on the OSGi framework. It provides a standard platform on which to run Software AG products and the enterprise applications you develop around those products. The Software AG Common Platform provides common infrastructure for user authentication, event handling, and the execution of Web applications. Infrastructure components that the Software AG Common Platform provide include Software AG Security Infrastructure, Software AG Web Server based on Apache Tomcat, and Web Services Stack.
The Software AG Runtime is an installable instance of the Software AG Common Platform that functions as a stand-alone Tomcat server and a container for Web applications. EntireX uses the Software AG Runtime to host the EntireX Listener for XML/SOAP and RPC Server for XML/SOAP.
The Software AG Web Server based on Apache Tomcat is one of the basic infrastructure components provided by the Software AG Common Platform. It provides HTTP/HTTPS services, a JSP engine, and a servlet container. Unlike a typical Tomcat implementation, the Software AG Web Server is OSGi-based and supports both .WAR-based and .WAB-based web applications.
During startup, the Software AG Web Server (service name: Software AG Runtime), including the EntireX bundle, looks in the EntireX profile for file <Installation home>/EntireX/etc/EXX/workspace/entirex.servers.properties. This file defines an RPC Server for XML/SOAP as within entirex.xmlrpcserver.properties and entirex.xmlrpcserver.configuration.xml located in the EntireX installation in subdirectory config by default.
After installation, the default RPC Server for XML/SOAP is not started automatically.
To enable autostart, change the configuration file
(set property start to "yes") and restart the Software AG Runtime.
The file entirex.servers.properties defines the servers to be started. It is only read during startup of the Software AG Runtime. Set the following properties for each defined server:
| Property Name | Description |
|---|---|
server. |
Enable autostart with "yes" or disable autostart with "no" (default). |
server. |
Path to properties file (Java notation). |
server. |
Path to configuration file (Java notation). |
where n is a number identifying the server
Example of entirex.servers.properties:
server.1.start=yes server.1.propertiesFile=c:/SoftwareAG/EntireX/config/entirex.xmlrpcserver.properties server.1.configurationFile=c:/SoftwareAG/EntireX/config/entirex.xmlrpcserver.configuration.xml server.2.start=no server.2.propertiesFile=c:/SoftwareAG/EntireX/config/entirex.myxmlrpcserver.properties server.2.configurationFile=c:/SoftwareAG/EntireX/config/entirex.myxmlrpcserver.configuration.xml
To deactivate an RPC Server for XML/SOAP, change its start property in the configuration file to "no".
To start and stop an RPC Server for XML/SOAP, open a JMX tool,
for example the Java Monitoring and Management Console (jconsole), located in the Java bin directory
(sample path: C:\SoftwareAG\jvm\w64_160\bin\jconsole.exe).
The tool should be connected to the Software AG Runtime JMX port remotely. The default number of this port is 8044 and is
defined in <Installation home>/ profiles/CTP/configuration/config.ini.
Switch to tab MBeans and select item com.softwareag.entirex.runtime.rpcserver. The following operations are available:
| Operation | Description |
|---|---|
| startServer | To start a registered and non-running RPC Server for XML/SOAP. The parameter is the service name (e.g. RPC/XMLSERVER/CALLNAT). |
| stopServer | To stop a running RPC Server for XML/SOAP. The parameter is the service name (e.g. RPC/XMLSERVER/CALLNAT). |
| registeredServer | Returns the list of service names of all configured RPC Server for XML/SOAPs. |
| runningServer | Returns the list of service names of running configured RPC Server for XML/SOAPs. |
| nonRunningServer | Returns the list of service names of non-running configured RPC Server for XML/SOAPs. |
Under Linux, the Software AG Runtime can be stopped and started using the following scripts:
suite_install_dir/profiles/CTP/bin/sagctpnn.sh stopsuite_install_dir/profiles/CTP/bin/sagctpnn.sh start
where nn represents the product version number.
Under Windows, the Software AG Runtime runs as a service and can be started and stopped using the Windows Administrative tools.
The relevant CTP profile has a Windows service named Software AG Runtime. You can see it in the Service dialog from the Windows Control Center. You can start/stop the service from this dialog.
The directory '<Installation Home>\ profile\CTP\bin' contains the following scripts to start and stop the Software AG Runtime:
| Script | Description |
|---|---|
| start_runtime.bat | batch script for starting a profile's runtime. If it is an installed service for the profile, it will start the service by default. |
| stop_runtime.bat | batch script for stopping a profile's runtime. If it is an installed service for the profile and this service has been started, this script will stop the service. |