XML/SOAP Listener

The EntireX XML/SOAP Listener runs in a servlet-enabled Web server with an installation of the Software AG Web Services Stack. It plugs the Web service's archives (EntireX Workbench file with extension .aar) into Web servers. Typically the Web service clients access the XML/SOAP Listener and send/receive XML/SOAP documents using HTTP/HTTPS. This component was formerly referred to as "XML Servlet".

This document covers the following topics:

Configuring Web Services
Installing Web Services Stack in a Web Server
Using Internationalization with the XML/SOAP Listener

See also Web Services Stack documentation in the Software AG Infrastructure Administrator's Guide, also available under http://documentation.softwareag.com > Guides for Tools Shared by Software AG Products.

Configuring inside a Web Service Archive

Individual settings for Web services or groups of Web services are contained in the services.xml file that is part of a Web service archive (Workbench file with extension .aar). Those settings originate from the Web Services Wrapper (default settings from generation) or from the Web Services Stack Configuration Editor (customized settings).

Using an External Configuration File

With an external configuration file you can override settings of the Web service's archive (EntireX Workbench file with extension .aar) without modifying the Web service archive itself. This means you can use the same Web service archive in different Web server environments.

Start of instruction set To use an external configuration file

Define a name and a location for the external configuration file.

In the parameter section of file axis2.xml, define a parameter "EntireX-XML-Listener" within a parameter "services". For the attribute "location" in parameter "services", specify an absolute or relative path to the external configuration file. File axis2.xml can be found in the conf directory or folder of the Web Services Stack Web application.
```
<parameter name="EntireX-XML-Listener">
   <parameter name="services" location="<path for file
                   overwriting settings of EntireX services>" />
</parameter>
```
Notes:
1. The path separator is a slash.
2. For the Web Services Stack, file axis2.xml is located in the Web Services Stack Web application's configuration directory <servlet_engine_root>\webapps\wsstack\WEB-INF\conf. The default location of the configuration folder of the Software AG Web Server based on Apache Tomcat is <SuiteInstallDir>/profiles/CTP/configuration. See also Configuration > Web Services Stack Runtime > Runtime Configuration in the Web Services Stack documentation in the Software AG Infrastructure Administrator's Guide, also available under http://documentation.softwareag.com > Guides for Tools Shared by Software AG Products.
3. The value of the location can contain operating system variables, for example location="$EXXDIR/config" (UNIX) or location="%USERPROFILE%/myconfig.xml" (Windows).

Define services in the external configuration file.

External configuration files are XML documents with a root element "serviceGroup". A service group is defined as a sequence of one or more services.

To identify the service you are defining, specify an identifier for the attribute "name", for instance <service name= "service100">.

To make common settings, that is, settings for all services, use an asterisk as identifier (<service name= "*">. Note that an individual setting can override a common setting.

EntireX web service parameters that can be set are defined as subelements of "service". See the table below.

Parameter	Description
`<exx-brokerID>`	The broker ID to use.
`<exx-service>`	The service name is the triple set of server class/server name/service.
`<exx-userID>`	The user ID specified here is used for calling the broker.
`<exx-password>`	The user ID specified here is used for calling the broker.
`<exx-password-encryption>`	Specifies how the password is encrypted in the configuration file. Encryption is performed automatically when the configuration file is read for the first time.
`<exx-use-security>`	Possible values: true\|false.
`<exx-rpc-userID>`	The RPC user ID specified here is used for Natural Security
`<exx-rpc-password>`	The RPC Password specified here is used for Natural Security.
`<exx-natural-security>`	Enable/Disable the Natural Security (true\|false).
`<exx-natural-library>`	The Natural library to use.

Installing Web Services Stack in a Web Server

Deploying Web Services Stack Runtime to Tomcat

If you want to deploy Web Services Stack Web application and EntireX XML runtime to your own Apache Tomcat installation, perform the following steps:

Start of instruction set To deploy to your own Apache Tomcat installation

Stop Apache Tomcat.
Make sure that the attribute unpackWars is set to "true" in the server.xml of your Apache Tomcat installation.
Copy wsstack.war to the webapps directory of your Apache Tomcat installation.
Start Apache Tomcat. The content of wsstack.war will be expanded into a directory wsstack under the webapps directory of the Apache Tomcat installation.
Stop Apache Tomcat.
Copy entirex.jar from the classes directory of your EntireX installation to the WEB-INF/lib directory of the expanded Web Services Stack Web application.
Start Apache Tomcat.

Now you can deploy generated EntireX Web services (.aar) from the EntireX Workbench.

Using Internationalization with the XML/SOAP Listener

The XML/SOAP Listener supports both conversion and translation. See Internationalization with EntireX for more information.