Administering the RPC Server for XML/SOAP with Local Scripts

The EntireX 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 works together with the XML/SOAP Wrapper.

This document describes how to administer the RPC Server for XML/SOAP with local scripts as in earlier versions of EntireX. It covers the following topics:

See also Administering the RPC Server for XML/SOAP with the Command Central GUI | Command Line.

Customizing the RPC Server

The following elements are used to set up the RPC Server for XML/SOAP:

Start Script

The start script for the RPC Server for XML/SOAP is called jxmlrpcserver.bsh (Linux) or jxmlrpcserver.bat (Windows) and is provided in the bin folder of the installation directory. You may customize this file.

You can set the environment variable JAVA_HOME for the location of the Java interpreter. Set the classpath to entirex.jar, wsstack-client.jar and saglic.jar.

The RPC Server for XML/SOAP accepts two unnamed parameters, broker_id and server_address. Default values are localhost:1971 and RPC/SRV/CALLNAT. Example: 

java –Dentirex.license.location=<license.xml with path> com.softwareag.entirex.xml.rt.XMLRPCServer broker_id server_address

Properties File

The default name of the properties file is entirex.xmlrpcserver.properties. The file is searched for in the directory of the Start Script. It can be changed by assigning an arbitrary file name with a path to a property with the name entirex.xmlrpcserver.propertyfile.

The following is a sample properties file entirex.xmlrpcserver.properties: 

# Example server configuration
#
# parameter for xml stream parser
entirex.sdk.xml.runtime.xmlparserfactory=com.ctc.wstx.stax.WstxInputFactory
# xmlruntime configuration file
entirex.sdk.xml.runtime.configurationfile=entirex.xmlrpcserver.configuration.xml
#
# Basic properties
entirex.server.brokerid=localhost
entirex.server.serveraddress=RPC/XMLSERVER/CALLNAT
entirex.server.userid=XMLRPCServer

It can define parser settings, for example JAXP parameters (optional if these parameters are already specified in your environment) and the location of the configuration file. A sample properties file is contained in subfolder config of the installation folder.

System Properties

Additionally, Java system properties are available to administer the RPC Server for XML/SOAP. These properties are independent of the administration possibilities listed above.

Java System Property Description Values Default
http.keepAlive Enable/disable HTTP persistence true, false true
http.maxConnections Define the maximum number of HTTP connections to a host.

Note:
Requires http.keepAlive=true

 Integer > 0 5
http.maxTotalConnections Define the maximum total number of HTTP connections to a host.

If http.maxConnections is greater than http.maxTotalConnections, this value is set to value of http.maxConnections.

Note:
Requires http.keepAlive=true

 Integer > 0 20

Configuration File

The configuration contains a list of target servers defined in the TargetServer block, including XML mapping files (XMM) associated with them and may contain information about the broker if not already given as a property (command-line option, system property or property file).

The default name of the configuration file is entirex.xmlrpcserver.configuration.xml. The file is searched for in the directory of the Start Script. It can be changed by assigning an arbitrary file name with a path to a property with the name entirex.xml.runtime.configurationfile.

The configuration file has the lowest priority. It is written in XML format. The document frame is:

<?xml version="1.0" encoding="UTF-8" ?> 
<EntireX xmlns="http://namespaces.softwareag.com/entirex/xml/runtime/configuration" version="10.9.0" >
      <XmlRuntime Version="1">
      <!-- information for RPC Server for XML/SOAP, see TargetServer Block -->
      </XmlRuntime>
</EntireX>

Configuring the RPC Server

The RPC Server for XML/SOAP uses the properties that start with "entirex.server" for configuring the RPC server side.

Alternatively to the properties, you can use the command-line options. These have a higher priority than the properties set as Java system properties, and these have higher priority than the properties in the configuration file.

Property Name Command-line Option Default Explanation
entirex.server.brokerid -broker localhost Broker ID. graphics/toc_closed.png More info
entirex.server.codepage -codepage  

The encoding configured for the Java virtual machine (JVM) is used to convert the Unicode (UTF-16) representation within Java to the encoding sent to or received from the broker by default. This encoding is also transferred as the codepage to the broker to tell the broker the encoding of the data. Changing the default encoding of the JVM has the side effect that the encoding for terminal and file IO is affected too. This may be undesired.

With the codepage parameter you can override the encoding without the need to change the default encoding of the JVM. The codepage must be supported by your JVM. For a list of valid encodings, see Supported Encodings in your Java documentation.

Note:
See your JVM documentation for how to change the default encoding of the JVM. On some JVM implementations, it can be changed with the file.encoding property. On some Linux implementations, it can be changed with the LANG environment variable.

Enable character conversion in the broker by setting the service-specific attribute CONVERSION to "SAGTRPC". See also Configuring ICU Conversion under z/OS | Linux | Windows | BS2000. More information can be found under Internationalization with EntireX.

See also Character Encoding for Outgoing XML Document.

entirex.server.compresslevel -compresslevel 0 (no compression) Enter the text or the numeric value:
BEST_COMPRESSION  9
BEST_SPEED  1
DEFAULT_COMPRESSION
  (mapped to		 -1
 6)
DEFLATED  8
NO_COMPRESSION  0
N  0
Y  8
graphics/toc_closed.png More info
entirex.server.development.​relativepaths false The file locations of deployed XMM and WSDL files are written as relative paths in configuration file of the RPC Server for XML/SOAP.
entirex.server.fixedservers   no
NO The number of worker threads balances between what is specified in entirex.server.minservers and what is specified in entirex.server.maxservers. This is done by a so-called attach thread. At startup, the number of worker threads is the number specified in entirex.server.minservers. A new worker thread starts if the broker has more requests than there are worker threads waiting. If more than the number specified in entirex.server.minservers are waiting for requests, a worker thread stops if its receive call times out. The timeout period is configured with entirex.server.waitserver.
See worker model DYNAMIC.
YES The number of worker threads specified in entirex.server.minservers is started and the server can process this number of parallel requests.
See worker model FIXED.
entirex.server.​ignoreSOAPActionNamespace false Possible values:
true Only the name part of SOAPAction is used, the namespace is ignored.
false The SOAPAction value is used as defined.

Note:
If a WSDL file is configured for this method, the property will be ignored and SOAPAction value defined in WSDL is used.

  -help   Display usage of the command-line parameters.
entirex.server.logfile -logfile   Path and name of the log file. Environment variables in the name are resolved only if used as command-line option.
entirex.server.minservers   1 Minimum number of server threads.
entirex.server.maxservers   32 Maximum number of server threads.
entirex.server.name     Server name.
entirex.server.password -password yes The password for secured access to the broker. The password is encrypted and written to the property entirex.server.password.e.

  • To change the password, set the new password in the properties file.

  • To disable password encryption, set entirex.server.passwordencrypt=no. Default=yes.

entirex.sdk.xml.runtime.​propertyfile -propertyfile entirex.xmlrpcserver.​properties Name of property file.
entirex.sdk.xml.runtime.​configurationfile -configurationfile entirex.xmlrpcserver.​configuration.xml Location and name of configuration file.
entirex.server.restartcycles -restartcycles 15 Number of restart attempts if the Broker is not available. This can be used to keep the RPC Server for XML/SOAP running while the Broker is down for a short time.
entirex.server.security -security no Valid values:
no | yes | auto | name of BrokerSecurity object.
entirex.server.serveraddress -server RPC/SRV1/CALLNAT Server address.
entirex.server.serverlog -serverlog   Name of the file where start and stop of the worker threads is logged. Used by the Windows RPC Service.
entirex.server.userid -user XMLRPCServer The user ID for access to the broker.
entirex.server.waitattach   600S Wait timeout for the attach server thread.
entirex.server.waitserver   300S Wait timeout for the worker threads.
entirex.timeout   20 TCP/IP transport timeout. graphics/toc_closed.png More info
entirex.trace -trace 0 Trace level. graphics/toc_closed.png More info
0 No tracing, default.
1 Trace all broker calls and other major actions.
2 Dump the send and receive buffer.
3 Dump the buffers sent to the broker and received from the broker.
entirex.sdk.xml.runtime.​xmlparserfactory -jaxp.saxparser​factory com.ctc.wstx.stax.​WstxInputFactory Location and name of stream parser factory class.
entirex.sdk.xml.runtime.​defaultFaultDocumentFormat soap soap Define the protocol used for fault document generation if no fault document is defined. Values: soap|xml.

Using SOAP 1.2 with the RPC Server

Generated Mapping (XMM)

Generate a new XML mapping file with SOAP mapping in the XML Mapping Editor, or use an existing one.

Note:
Do not change the namespace for SOAP. This must be the namespace for SOAP version 1.1.

Configure XMM

To use SOAP 1.2 for an XMM file, add the attribute soapVersion to section xmms in element exx-xmm in the configuration file. See soapVersion under TargetServer Block below for details.

Locating and Calling the Target Server

The IDL library and IDL program names that come from the RPC client are used to locate the target server. See library-definition and program-definition under Software AG IDL Grammar in the IDL Editor documentation. This two-level concept (library and program) is mapped to a target servers using an XML mapping file (XMM) together with connection information. Both connection information and XML mapping files are defined in the target server block of the Configuration File.

Mapping Software AG IDL files to XML/SOAP is described under XML Structures and IDL-XML Mapping in the XML/SOAP Wrapper documentation. This section describes the following elements to define servers:

TargetServer Block

The section <TargetServer> specifies a target server with mandatory HTTP(S) web service address in the name attribute.

Tip:
If you are using a target located outside the firewall, set the following Java properties:

  • http.proxyHost

  • http.proxyPort

  • http.nonProxyHosts

  • http.proxyUser

  • http.proxyPassword

Configuring SSL/TLS to the target server is described under Using SSL/TLS with the RPC Server.

The block contains section <xmms> with EntireX XML mapping files (XMM files). Each <TargetServer> entry can have a list of XMMs for its server.

Caution:
It is not allowed to use one XMM in more than one TargetServer entry inside one configuration file.

Within the <TargetServer> tag you can specify basic authentication with a fixed user/password:

Attribute Req/
Opt 		Description
basicAuthentication O
true Activate the basic authentication.
If attributes user and password are set, these credentials are used for basic authentication.
Otherwise the current credentials of the calling RPC client are used.
false Deactivate basic authentication. All other parameters in this table are ignored.
user O Name of default user for basic authentication.
password O Password of default user for basic authentication.
password-encryption O Specifies how the password is encrypted. Possible values:
plainText Default.
base64  
encrypt The RPC Server for XML/SOAP encrypts the password and sets this value.
httpConnectionTimeout R HTTP connection timeout in seconds.

The section <xmms> contains the optional attributes for SOAP mapping.

Attribute Description
soapVersion Specifies a SOAP version: 1.1 (default) or SOAP 1.2.
wsdl The location of WSDL file, using a WSDL file the target address is retrieved from WSDL file.
service The service name in WSDL file.
port The port name in WSDL file.
repository The repository directory used for WS-* features. See Software AG Web Services Stack client repository.
usernameToken Valid values: PasswordText | PasswordDigest.

Prerequisites: Attribute repository must be defined and module rampart must be engaged. See also UsernameToken Security.

Sample configuration file:

<?xml version="1.0" encoding="UTF-8" ?> 
<EntireX 
  xmlns="http://namespaces.softwareag.com/entirex/xml/runtime/configuration" 
  version="10.9">
  <XmlRuntime Version="1">

   <TargetServer name="http://localhost:1973/MyService">
      <xmms>
        <exx-xmm name="c:\mydir\xmmfiles\XmmExample.xmm" 
          soapVersion="1.1" 
          wsdl="c:/mywsdl.wsdl" service="myservice" 
          port="myserviceSOAP11Port" repository="c:\myrepository"\>
      </xmms>
    </TargetServer>
  </XmlRuntime>
<EntireX>

HTTP Basic Authentication

Basic authentication is used for a target server if the attribute basicAuthentication is defined in the TargetServer block. Basic authentication is used for all calls associated with the defined XMM files for the <TargetServer>.

Basic authentication can be used with fixed credentials or credentials set from the RPC client application:

See also Generating a Web Service with HTTP Basic Authentication and UsernameToken Authentication for EntireX Authentication under Using the EntireX Web Services Wrapper.

UsernameToken Security

UsernameToken security is used for a target server if attribute usernameToken is defined in <xmms>. Two kinds of UsernameToken are supported:

  • PasswordText

  • PasswordDigest

The repository must be defined in section <xmms>, for example: 

<exx-xmm name="AService.xmm" soapVersion="1.1" 
repository="myrepository" usernameToken="PasswordText" />

The repository must contain module rampart. In the configuration file (axis2.xml) the rampart module must be engaged (<module ref="rampart"/>) and the phase PreSecurity can be empty (<phase name="PreSecurity" />).

Natural logon must be set in the RPC client application. Additionally the RPC client application should set RPC user ID and RPC password.

See also Generating a Web Service with HTTP Basic Authentication and UsernameToken Authentication for EntireX Authentication under Using the EntireX Web Services Wrapper.

WS-* Features (e.g. WS-Policy)

To use WS-* features such as WS-Policy you need to define the repository location (used by underlying Software AG Web Services Stack) and the WSDL file location, including service name and port name in the configuration file of the RPC Server for XML/SOAP. A sample repository is provided in the installation (<installation_home>/WS-Stack).

For specifying features such as WS-Policy, see configuration of Software AG Web Services Stack.

User Exit to Set Additional HTTP Headers

The following user exit allows you to add HTTP headers before the call, or - in case of HTTP error 401 (authentication) - to add an HTTP header to optional retry call, for example to support SPNEGO (Simple and Protected GSSAPI Negotiation Mechanism).

Writing the User Exit

Implement the interface com.softwareag.entirex.xml.rt.IHttpTransportUserExit with the two methods addHttpHeaders and retryOnAuthenticationError. See also the sample implementation, including the Javadoc. Sample user exit: 

package sample;

import java.util.Properties;

import com.softwareag.entirex.xml.rt.IHttpTransportUserExit;

/**
 * implementation of user exit must be thread-safe
 */
public class SampleHttpTransportUserExit implements IHttpTransportUserExit {
    
 private String getToken(String user, String endpoint) {
   // add your implementation here
   return "";
 }

  /**
   * Method to add HTTP header. 
   * Method is called before first call and 
   * if an HTTP error 401 occurred and retryOnAuthenticationError() is true
   * @param settings properties containing user and endpoint
   * @param httpHeaders 
   */
 @Override
 public void addHttpHeaders(Properties settings, Properties httpHeaders) {
   String user = settings.getProperty("user");
   String endpoint = settings.getProperty("endpoint");
   
   httpHeaders.setProperty("Authorization", "Negotiate " + getToken(user, endpoint));
 }

  /**
   * @return should make a retry call on authentication error (401) 
   */
 @Override
 public boolean retryOnAuthenticationError() {
  return true;
 }

}

Adapting the Configuration of the RPC Server for XML/SOAP

On element TargetServer, add the attribute httpTransportUserExit with the qualified name of the user exit in the configuration file: 

<?xml version="1.0" encoding="UTF-8"?>
<EntireX version="10.9" xmlns="http://namespaces.softwareag.com/entirex/xml/runtime/configuration">
  <XmlRuntime Version="1">
    <TargetServer name="http://localhost:8080/wsstack/services/exampleSOAP"
    httpConnectionTimeout="60" 
    httpTransportUserExit="sample.SampleHttpTransportUserExit" 
     >
    <xmms>
     <exx-xmm name="C:/example.xmm" soapVersion="1.1" />
    </xmms>
    </TargetServer>
 </XmlRuntime>
</EntireX>

Adapting the Start Script

Add the user exit to classpath in the start script.

Client Application

To set the credentials - this means that the user ID is available in user exit on the client side - the Natural logon must be enabled. User-specific credentials can be overwritten by setting the RPC user ID and RPC password in the client application.

Character Encoding for Outgoing XML Document

The encoding for the outgoing XML document is determined by the XML Default Encoding defined in the XML mapping file. See Defining the XML Encoding in the XML Mapping Editor documentation.

Using SSL/TLS with the RPC Server

RPC servers can use Secure Sockets Layer/Transport Layer Security (SSL/TLS) as the transport medium. The term "SSL" in this section refers to both SSL and TLS. RPC-based servers are always SSL clients. The SSL server can be either the EntireX Broker or Broker SSL Agent. For an introduction see SSL/TLS, HTTP(S), and Certificates with EntireX in the platform-independent Administration documentation.

To use SSL with RPC Server for XML/SOAP, you need to configure two sides: the RPC server side and the target server side.

Start of instruction setTo configure SSL/TLS with the RPC server side

  1. To operate with SSL, certificates need to be provided and maintained. Depending on the platform, Software AG provides sample certificates, but we strongly recommend that you create your own. See SSL/TLS Sample Certificates Delivered with EntireX in the EntireX Security documentation.

  2. Set up the RPC Server for XML/SOAP for an SSL connection.

    Use the URL-style Broker ID with protocol ssl:// for the Broker ID. If no port number is specified, port 1958 is used as default. Example: 

    ssl://localhost:22101?trust_store=C:\SoftwareAG\EntireX\etc\ExxCACert.p12&trust_passwd=ExxCACert&verify_server=no

    If the SSL client checks the validity of the SSL server only, this is known as one-way SSL. Two SSL parameters must be specified on the SSL client side: trust_store and trust_passwd. The mandatory trust_store parameter specifies the file name of a PKCS#12 certificate store that must contain the certificate chain of the trusted certificate authority (CA) that issued the SSL server's certificate.
    To unlock this certificate store, the password has to be set with SSL parameter trust_passwd.
    By default a check is made that the certificate of the SSL server is issued for the hostname specified in the Broker ID. The common name of the subject entry in the server's certificate is checked against the hostname. If they do not match, the connection will be refused.
    You can disable this check with SSL parameter verify_server=no.

    If the SSL server additionally checks the identity of the SSL client, this is known as two-way SSL. In this case the SSL server requests a client certificate (the parameter verify_client=yes is defined in the configuration of the SSL server). Two additional SSL parameters must be specified on the SSL client side: key_store and key_passwd. This keystore must contain the private key of the SSL client. The password that protects the private key is specified with key_passwd.

    The ampersand (&) character cannot appear in the password.

    SSL parameters are separated by ampersand (&). See also SSL/TLS Parameters for SSL Clients.

  3. Make sure the SSL server to which the RPC Server for XML/SOAP connects is prepared for SSL connections as well. The SSL server can be EntireX Broker or Broker SSL Agent. See:

Start of instruction setTo configure SSL/TLS to a target server

  1. Using HTTPS to the target server requires setting Java SSL/TLS properties and changing the protocol of the target server's web service in the Configuration File.

    If the web service has to be called via HTTPS (SSL/TLS), the SSL client (here the RPC Server for XML/SOAP) needs the correct certificate for the web service in the truststore to be able to communicate via SSL. The certificate can either be stored in the default truststore of the JVM or in the truststore specified with the following Java properties: 

    -Djavax.net.ssl.trustStore=path_to_used_truststore

    If truststore access requires a password:

    -Djavax.net.ssl.trustStorePassword=theTruststorePassword

    The SSL parameters must be included in quotes, for example

    set SSL="-Djavax.net.ssl.trustStore=C:\myTrustStore.p12 -Djavax.net.ssl.trustStorePassword=myTruststorePassword"

    Note:
    This is only an example. You must provide a truststore that matches your environment.

    The truststore keeps the trusted certificate of the web service host or the certificate of its signing (issuing) certificate authority. In the event of an SSL error, you can use the Java property -Djavax.net.debug=all to get more information. Add the SSL parameter to the start script of the RPC Server for XML/SOAP and ensure it is passed to the start or Java. Example: 

    ...
set SSL="-Djavax.net.ssl.trustStore=C:\myTrustStore.p12 -Djavax.net.ssl.trustStorePassword=myTruststorePassword -Djavax.net.debug=all"
...
"%JAVA_HOME_BIN%java" %PROXY% %SSL% -classpath "%CLASSPATH%" com.softwareag.entirex.xml.rt.XMLRPCServer -p "%EXXPROP%" -c "%EXXCONF%" %*

    There are additional Java properties, which are usually not needed. These are described in the Java documentation.

  2. Optional. If you are using an HTTPS target server's web service address located outside the firewall, set the following Java properties:

    • https.proxyHost

    • https.proxyPort

    • http.nonProxyHosts

    • https.proxyUser

    • https.proxyPassword

  3. Change the protocol of the target server's web service address from http to https in the configuration file. Specify the fully qualified host name as TargetServer. The host name has to match the CN (Common Name) item of the host certificate. See also Configuration File. Example: 

    <?xml version="1.0" encoding="iso-8859-1" ?>
<EntireX
xmlns="http://namespaces.softwareag.com/entirex/xml/runtime/configuration" version="10.9"
>
    <XmlRuntime Version="1">
       <TargetServer name="https://targethost:8080/entirex/xmlrt">
            <xmms>
                <exx-xmm name="yourFile1.xmm" />
                <exx-xmm name="yourFile2.xmm" />
            </xmms>
        </TargetServer>
    </XmlRuntime>
</EntireX>

Starting the RPC Server

Start of instruction setTo start the RPC Server for XML/SOAP

  • Use the Start Script.

    Or:
    At the command prompt, enter: 

    java com.softwareag.entirex.aci.XMLRPCServer broker_id server_address

You can pass command-line options and customize your environment as described under Start Script.

Stopping the RPC Server

Start of instruction setTo stop the RPC Server for XML/SOAP

Pinging the RPC Server

Start of instruction setTo ping the RPC Server for XML/SOAP

  • Enter the following command:

    java -classpath "$EXXDIR/classes/entirex.jar" com.softwareag.entirex.rpcping.RPCServerPing -p <admin_port>
    where admin_port is the number of the administration port.

    The ping command returns "0" if the server is reachable, and "1" if the server cannot be accessed.

    Note:
    This command is particularly useful in a high availability cluster context. See Setting up your Environment for High Availability with Container Orchestration in the High Availability documentation.

Running an EntireX RPC Server as a Windows Service

For general information see Running an EntireX RPC Server as a Windows Service in the Windows Administration documentation.

Start of instruction setTo run the RPC Server for XML/SOAP as a Windows Service

  1. Customize the Start Script according to your system installation.

    Note:
    The script file must pass external parameters to the RPC server: 

    java com.softwareag.entirex.xml.rt.XMLRPCServer %*

    See also Starting the RPC Server.

  2. Test your RPC server to see whether it will start if you run your script file.

  3. Use the EntireX RPC Service Tool and install the RPCService with some meaningful extension, for example MyServer. If your Start Script is jxmlrpcserver.bat, the command will be 

    RPCService -install -ext MyServer -script install_path\EntireX\bin\jxmlrpcserver.bat

    The log file will be called RPCservice_MyServer.log.

  4. In Windows Services menu (Control Panel > Administrative Tools > Services) select the service: Software AG EntireX RPC Service [MyServer] and change the property Startup Type from "Manual" to "Automatic".