Web Services Client adapter overview
The process of adding a Web Services Client adapter to an Apama project involves the following (which is described on more detail in the topics below):
1. Add the Web Services Client Adapter resource bundle to an Apama project.
2. Configure the Web Services Client adapter, which involves:
a. Specifying the WSDL (Web Service Definition File) that points to the web service.
b. Specifying a web service operation or operations your application will invoke.
c. Mapping Web Service Client adapter parameters.
The Web Services Client Adapter editor contains the following tabs:
SettingsEvent Mappings XML Source Advanced Settings tab
The Web Services Client Adapter editor's Settings tab presents configuration information in two sections: Classpath and General Properties. The Classpath section lists the required classpath entries and lets you add or remove them.
General Properties
APAMA_HOME — Directory that contains your Apama installation.
ADAPTERS_JARDIR — Directory that contains the Java archive files for Apama adapters.
ADAPTER_INSTANCE_ID — Identifier for this instance of the Web Services Client adapter.
WS_SPRING_PATH — Directory that contains the Web Services Client adapter's Spring configuration file. By default, the location is automatically inserted.
WS_SPRING_FILE_NAME — Name of the file that contains the Web Services Client adapter's Spring configuration. By default, this is automatically set.
CORRELATOR_HOST — Specifies the name of the host machine where the project's default correlator runs. By default this is automatically set.
CORRELATOR_PORT — Specifies the port used by the correlator. By default this is automatically set.
You can add general properties by clicking the plus sign button just below the General Properties title and filling in the property's name and value.
Event Mappings tab
The Web Services Client Adapter editor's Event Mappings tab lists the web service operations your Apama application can invoke. You can add, edit or remove operations here. For each operation, you define event-to-operation mappings for web service input (request message), and optionally for web service output (response messages)and fault messages. To define mappings for an operation, select the operation name in the top part of the Event Mappings tab.
The Mapping Definitions area has a tab for each event you associate with the operation. At the top of each tab, there is a correlation ID field where you can select the correlation ID field for that event. On the Input tab, you map the input event to the operation's request parameters. If you specified an output event for the operation, then there is an Output tab. On the Output tab, you map the operation response parameters to the specified output event. If you specified a fault event for the operation, then there is a Fault tab. On the Fault tab, you map the operation error parameters to the specified fault event.
In the Mapping Element Details area you can specify and view XSLT and XPATH transformation for particular mappings.
XML Source tab
The XML Source tab on the adapter editor displays the XML code for the adapter's configuration file. Use this tab if you need to modify the properties in the configuration file.
Advanced tab
The Advanced tab displays links to the adapter instance files and generated files.