Configuring the Web Services adapter
Adapter type: ro-adapter-ws[version]
Default adapter name: SOAPAdapter
For the Web Service Method Two and JAX-WS approach, use the proxy settings shown in the <config> section in XML sample for the Web Services adapter configuration with proxy settings only if you use a proxy server for Internet connectivity. Web Service Method One does not work with these settings.
The Web Services adapter supports uploading attachments to the outgoing SOAP request and downloading attachments embedded in the SOAP response received from the web server.
To configure the Web Services adapter, see Configuring base adapters.
The following table describes the adapter configuration elements for the Web Services adapter that you can specify by using the form view, XML view, or both. You cannot use the form view to configure elements and attributes that do not have an entry in the "UI label" column.
Configuration node elements for the Web Services adapter
While the adapter does not require a configuration node, an XML tag, <config/> is required for the Properties field in Grid Manager adapter configuration. The following figure shows an XML template of the adapter configuration for the Web Services adapter. The following configuration clears the cache after a delay of 120 minutes.
XML template of the Web Services adapter configuration
<config>
<clear-asynchronous-cache></clear-asynchronous-cache>
<delay></delay>
<timestamp></timestamp>
<time-to-live></time-to-live>
<username-token></username-token>
<user-name></user-name>
<password></password>
<password-type></password-type>
<character-set></character-set>
<nonce-validation></nonce-validation>
<created-validation></created-validation>
<sign-request></sign-request>
<attachment-destination-directory></attachment-destination-directory>
<signature-properties mode="key-files">
<sign-username-token></sign-username-token>
<sign-timestamp></sign-timestamp>
<private-key-file></private-key-file>
<certificate-file></certificate-file>
</signature-properties>
<signature-properties mode="key-data">
<private-key-data></private-key-data>
<certificate-data></certificate-data>
</signature-properties>
<signature-properties mode="keystore">
<keystore-file></keystore-file>
<keystore-password></keystore-password>
<alias></alias>
<password></password>
</signature-properties>
<use-connection-pooling></use-connection-pooling>
<max-connections></max-connections>
<connection-ttl></connection-ttl>
</config>
The configuration shown in the following figure does not clear the cache:
XML sample of the Web Services adapter configuration that does not clear the cache
<config>
<clear-asynchronous-cache>false<clear-asynchronous-cache>
<delay>120</delay>
</config>
The following figure shows an XML sample for the Web Services adapter configuration with proxy settings:
XML sample for the Web Services adapter configuration with proxy settings
<proxy-settings>
<host>10.10.255.255</host>
<port>8070</port>
<user-name>testuser</user-name>
<password>testpassword</password>
</proxy-settings>
</config>
The following figures show the sample adapter configurations for Web Services adapters that require an XML digital signature and a signed Username Token in the Security header of the SOAP envelope. For the key-files or the key-data mode, you must provide the X.509 Certificate (public key) and the private key files or the private key data in unencrypted Base64-encoded Privacy Enhanced Mail (PEM) format.
XML sample of the Web Services adapter configuration for key-files mode
<config>
<timestamp>true</timestamp>
<time-to-live>120</time-to-live>
<sign-request>true</sign-request>
<signature-properties mode="key-files">
<sign-timestamp>true</sign-timestamp>
<private-key-file>C:\Security\pk-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM
</private-key-file>
<certificate-file>C:\Security\cert-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM
</certificate-file>
</signature-properties>
</config>
XML sample of the Web Services adapter configuration for key-data mode
<config>
<timestamp>true</timestamp>
<time-to-live>120</time-to-live>
<sign-request>true</sign-request>
<signature-properties mode="key-data">
<sign-timestamp>true</sign-timestamp>
<private-key-data>-----BEGIN PRIVATE KEY-----
MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAAoGBAKomKro6VbW4PeQtUhNzZpSH26vb....IoKFbuJhln+tlJdmN16mzl1QnyDi469i2C/yXQEvNkjiDQGHrMlhA+0eik8+JuL/TEwgrcOYKP5B
I0XNL71L
-----END PRIVATE KEY-----</private-key-data>
<certificate-data>-----BEGIN CERTIFICATE-----
MIICdzCCAeCgAwIBAgIFXseN1xYwDQYJKoZIhvcNAQEFBQAwUzELMAkGA1UEBhMC....m/0iDplDR7XkyTxAx0AWo0RF4mstOszPGbpHBKFri2qxyXM0NmIPX2dJqhKICXP4
8HATrUjWl+peSog=
-----END CERTIFICATE-----</certificate-data>
</signature-properties>
</config>
The following figure shows the sample adapter configuration for Web Services that require an XML digital signature and signed Username Token in the Security header of the SOAP envelope. For the key-store mode, you must provide the keystore (JKS type) containing the X.509 Certificate (public key) and the private key.
XML sample of the Web Services adapter configuration for key-store mode
<config>
<username-token>true</username-token>
<user-name>Demo</user-name>
<password> </password>
<password-type>plain-text</password-type>
<nonce-validation>true</nonce-validation>
<created-validation>true</created-validation>
<sign-request>true</sign-request>
<signature-properties mode="keystore">
<sign-username-token>true</sign-username-token>
<keystore-file>C:\Security\bmcatriumwsclient_7.5.00.001.jks
</keystore-file>
<keystore-password>atrium</keystore-password>
<alias>bmcatriumwsclient</alias>
<password>atrium</password>
</signature-properties>
</config>
The following figure shows the sample configuration for the Web Services adapter that supports downloading attachments:
XML sample of the Web Services adapter configuration that supports downloading attachments
<config>
<attachment-destination-directory>D:\Soap_Attachments
</attachment-destination-directory>
</config>