Web Service Call builder inputs for a SOAP service

Portlet Factory, Version 6.1.2

Web Service Call builder inputs for a SOAP service

This topic describes the inputs for the Web Service Call builder for a SOAP service.

Table 1. Web Service Call builder inputs for a SOAP service
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Service Call Type Enable SOAP to configure a Simple Object Access Protocol service.
Request Parameters

SOAP URL Enter the URL for the service. The URL is not included in the SOAP envelope and must be known prior to creating the service call.
Target Method Using the above SOAP envelope as an example, the value of Target Method is: getServiceResponsePublic.
Method Namespace urn:MyBubble- SoapServices
Schema Namespace http://www.w3.org/2001/XMLSchema
SOAP Action Default is an empty String "". If the service you are calling specifies a SOAP action, enter that URL here. The SOAP action will be sent as an HTTP header.
For example, http://www.serviceobjects.com/GetTrackingInfo.
(optional) Literal Data If the target SOAP service is document style, enable this checkbox. If the SOAP service is RPC style, you can leave this checkbox disabled.
Arguments Enter the argument name, Java class and value for each argument you want to pass to the service.
Reply class Enter the name of the Java class for the service's response, such as string, or int.
Advanced

(optional) Timeout Default is 30 seconds.
(optional) SOAP Headers Use this input if you want to include additional SOAP headers in the service call that were not specified in the WSDL. Reference an XML variable that contains the value for the header.
(optional) HTTP Headers Use this input to send additional HTTP headers in the request. In the HTTP Header list, enter any HTTP Header names and set the header values using the Choose Reference dialog, or enter a text string directly.
(optional) Logging Select the type of logging, if any, that you want the builder to perform. Information will be written to the application server's console as well as IBM® WebSphere Portlet Factory's log file and can help in debugging problems with the service.
You can choose:

None

To disable logging.

Inputs and outputs only

To dump the inputs and the response.

Envelopes only

To dump the SOAP request and response envelopes for a WSDL/SOAP service call.

All

To dump all the above information.

(optional) Dummy/Stub Result Supply a value to be returned instead of actually calling the service.
For example, you might enable this functionality for testing purposes during application development so that you can run the model without requiring the other target model to be in place.
(optional) Username (Basic Auth) If the service requires basic user authentication, enter the user name to use for the request here.
(optional) Password (Basic Auth) If the service requires basic user authentication, enter the password for the specified user here.
(optional) Encoding Style Used when accessing some developer tool kits to specify alternate argument encodings. Can be generally left blank.
(optional) HTTP Proxy Host Enter the host name of the proxy server.
Note: This proxy setting and those below allow the setting of a proxy for this specific service call. As a result, a system wide JVM -Dhttp.proxyXXX setting does not need to be used. If a system-wide proxy setting is in effect, proxy settings made here in the Web Service Call builder will override the system value.
(optional) HTTP Proxy Port Enter the port number of the proxy server.
(optional) HTTP Proxy user Enter a user name for the proxy server.
(optional) HTTP Proxy Password Enter a password associated with the user name above.

SOAP Header Return Behavior

As of WebSphere Portlet Factory version 5.9, the new AXIS SOAP header construct returns multiple SOAP headers as XML data. Prior to this version, only the first header in the list of headers was returned. You can control header return behavior with an argument you can invoke at WebSphere Portlet Factory startup. If you prefer to revert WebSphere Portlet Factory to the old behavior of returning only the first SOAP header, start WebSphere Portlet Factory with the following argument:
-Dbowstreet.responseHeader.getFirstChild=true

When started in the way only a single response header will be returned as a result of a SOAP request.
Parent topic: Web Service Call builder

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Service Call Type	Enable SOAP to configure a Simple Object Access Protocol service.
Request Parameters
SOAP URL	Enter the URL for the service. The URL is not included in the SOAP envelope and must be known prior to creating the service call.
Target Method	Using the above SOAP envelope as an example, the value of Target Method is: getServiceResponsePublic.
Method Namespace	urn:MyBubble- SoapServices
Schema Namespace	http://www.w3.org/2001/XMLSchema
SOAP Action	Default is an empty String "". If the service you are calling specifies a SOAP action, enter that URL here. The SOAP action will be sent as an HTTP header. For example, http://www.serviceobjects.com/GetTrackingInfo.
(optional) Literal Data	If the target SOAP service is document style, enable this checkbox. If the SOAP service is RPC style, you can leave this checkbox disabled.
Arguments	Enter the argument name, Java class and value for each argument you want to pass to the service.
Reply class	Enter the name of the Java class for the service's response, such as string, or int.
Advanced
(optional) Timeout	Default is 30 seconds.
(optional) SOAP Headers	Use this input if you want to include additional SOAP headers in the service call that were not specified in the WSDL. Reference an XML variable that contains the value for the header.
(optional) HTTP Headers	Use this input to send additional HTTP headers in the request. In the HTTP Header list, enter any HTTP Header names and set the header values using the Choose Reference dialog, or enter a text string directly.
(optional) Logging	Select the type of logging, if any, that you want the builder to perform. Information will be written to the application server's console as well as IBM® WebSphere Portlet Factory's log file and can help in debugging problems with the service. You can choose: None To disable logging. Inputs and outputs only To dump the inputs and the response. Envelopes only To dump the SOAP request and response envelopes for a WSDL/SOAP service call. All To dump all the above information.
(optional) Dummy/Stub Result	Supply a value to be returned instead of actually calling the service. For example, you might enable this functionality for testing purposes during application development so that you can run the model without requiring the other target model to be in place.
(optional) Username (Basic Auth)	If the service requires basic user authentication, enter the user name to use for the request here.
(optional) Password (Basic Auth)	If the service requires basic user authentication, enter the password for the specified user here.
(optional) Encoding Style	Used when accessing some developer tool kits to specify alternate argument encodings. Can be generally left blank.
(optional) HTTP Proxy Host	Enter the host name of the proxy server. Note: This proxy setting and those below allow the setting of a proxy for this specific service call. As a result, a system wide JVM -Dhttp.proxyXXX setting does not need to be used. If a system-wide proxy setting is in effect, proxy settings made here in the Web Service Call builder will override the system value.
(optional) HTTP Proxy Port	Enter the port number of the proxy server.
(optional) HTTP Proxy user	Enter a user name for the proxy server.
(optional) HTTP Proxy Password	Enter a password associated with the user name above.