Integration Server 10.5 | Built-In Services Reference Guide | Client Folder | Summary of Elements in this Folder | pub.client:soapRPC
 
pub.client:soapRPC
WmPublic. Deprecated - There is no replacement service.
Submits a SOAP remote procedure call via HTTP or HTTPS.
Input Parameters
address
String String specifying the numeric address or name of the server on which the remote procedure resides. If you are submitting the request to an Integration Server, remember to direct it to the RPC processor as shown in the following example:
http://rubicon:5555/soap/rpc
reqParms
Document The input parameters that are to be passed to the remote procedure. For example, if you wanted to pass three String parameters, acct, amt, and org, containing the values Cash, 150.00, and Sales, reqParms would contain the following:
Key
Value
acct
Cash
amt
150.00
org
Sales
method
Document The QName of the requested procedure where:
Key
Value
namespaceName
String Namespace portion of the procedure's QName.
localName
String Local portion of the procedure's QName.
auth
Document Optional. User name and password that are to be submitted to the server specified in address.
Key
Value
type
String Type of authentication that the service will perform. Leave this field blank, as the only option currently available is basic HTTP authentication.
user
String User name that this service will use if one is requested.
pass
String Password that this service will submit if one is requested.
targetInputSignature
String Optional. Fully qualified name of the IS document type to use to validate and encode the contents of reqParms.
targetOutputSignature
String Optional. Fully qualified name of the IS document type to use to validate and decode the output value returned by the remote procedure.
SOAPAction
String Optional. Value to which you want to set the SOAPAction HTTP header.
contentType
String Optional. Specifies the value of Content-Type in the HTTP header. Set to:
*text/xml; charset="utf-8" to specify the content type as XML and the character encoding of the text as UTF-8. This is the default.
*text/xml to specify the content type as XML. Since the charset parameter is not specified, the character encoding of the text defaults to US-ASCII.
encoding
String Optional. Specifies the encoding method. Default value is UTF-8.
loadAs
String Optional. Specifies the format of the soapResponseData. Default value is stream. Set to:
*stream to return the body of the response as a java.io.InputStream. Use this option when you will invoke an HTTP web service. This is the default.
*byteArrayStream to have the response stream fully read and converted to java.io.ByteArrayStream. This prevents data loss or a truncated SOAP response if the connection closes prematurely. Use this option when you will invoke an HTTPS web service.
timeout
String Optional. Time (measured in milliseconds) to wait for a response from the server hosting the remote procedure before timing out and terminating the request. The default value is to wait forever.
Output Parameters
soapResponseData
Object A SOAP object containing the SOAP response message returned by the server specified in address.
respParms
Document Output parameters returned by the remote procedure. For example, if the remote procedure returned two String parameters, status and balance, containing the values closed and -4.95, respParms would contain the following:
Key
Value
status
closed
balance
-4.95
header
Document Conditional. Headers from the HTTP response. Will contain the following keys:
Key
Value
lines
Document Header fields from the HTTP response. Each key in lines represents a field (line) of the response header. Key names represent the names of header fields. The keys' values are Strings containing the values of the fields.
status
String Status code from the HTTP response.
statusMessage
String Status message from the HTTP response.
soapStatus
String Flag indicating whether the SOAP request message was processed successfully.
A value of...
Indicates that...
0
The remote server successfully processed the SOAP request and returned a SOAP response message.
1
The remote server returned a SOAP fault, indicating that the SOAP request was received but was not processed successfully.
2
The server returned an error that was not a SOAP fault. This indicates that some type of HTTP error occurred (often, an HTTP 404). You can check the status field in header to determine the type of HTTP error that occurred.
Usage Notes
This service is deprecated. There is not a replacement service.
To disable output validation for pub.client:soapRPC, set the watt.server.soap.validateResponse server configuration parameter to false. For more information about watt.server.soap.validateResponse, see webMethods Integration Server Administrator’s Guide.
If address begins with https:, you can use pub.security.keystore:setKeyAndChain to specify the certificate chain. If you do not specify a certificate chain, pub.client:soapRPC uses the default outbound SSL certificate settings to authenticate the resources.
See Also
pub.client:soapHTTP