Portlet Factory, Version 6.1.2

 

Web Service Call builder inputs for a WSDL-based SOAP service

This topic describes the inputs that the Web Service Call builder takes for a SOAP service defined in a WSDL document.

 

General Inputs

Table 1. Web Service Call builder General inputs for a WSDL-based 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 WSDL to configure a service defined in a Web Services Description Language document.
WSDL URL Enter the URL for the WSDL document describing the service.

The URL may be HTTP-based, (for example, http://myhost/mywsdl.wsdl) or a file within the project, such as WEB-INF/mywsdl.wsdl.

Click Refresh/fetch WSDL to display the operations exposed for the web service.

 

WS-Security

Table 2. Web Service Call builder WS-Security inputs for a WSDL-based SOAP service
Input Name Description
LTPA Binary Token Select to add the Lightweight Third-Party Authentication (LTPA) token of an already authenticated user to the SOAP header.
Username Token Select to input a username and password to be included in a WS-Security username token in the generated SOAP header.
Username This input is available if the Username Token input is selected.

Enter the id of the user to be authenticated.

Password This input is available if the Username Token input is selected.

Enter the password to use for authentication.

Username Token Profile Version This input is available if the Username Token input is selected.

Enter the specification for or select the file that contains the OASIS Web Services Security Username Token Profile version.

 

Request Parameters

Table 3. Web Service Call builder Request Parameters inputs for a WSDL-based SOAP service
Input Name Description
Operation Select the operation you want to execute. Each operation listed will indicate if the operation type is RPC or Document.
AutoCreate Input Vars Enable this input to force the Web Service Call builder regeneration to create input variables for each of the service call inputs. You can see these variables in the Variable section of the WebApp Tree view after clicking Apply on the builder call. The names are in the form of, buildername_argN_inputname.

These variables do not appear in the builder call list, but you can get and set their values in methods and they are listed in the Choose Reference dialog.

Note: To preserve pre-existing values in the builder input fields, request parameter inputs with existing content do not get automatically populated with the auto created variable names. To get the automatically created input variable names into the request parameter inputs, clear out the current value, and either choose the new variable with the selector for that input field, or just uncheck and recheck the AutoCreate Input Vars input. This technique allows hard-coded and automatically-created variables to be used in the inputs without loss of pre-existing typed in values.

Argument(s) (named according to WSDL document) The builder call editor displays the argument names for the selected operation as inputs to the web service call.

You can use the Choose Reference dialog to specify an appropriate value from a model element or you can enter a text string directly.

If the operation is RPC style, there is an input for each argument. If the operation is doc-literal or document-literal style, the service takes only one argument (an XML document) of the type indicated in the argument label.

 

Request SOAP Headers

Table 4. Web Service Call builder Request SOAP Headers inputs for a WSDL-based SOAP service
Input Name Description
Header name and Type Displayed when returned WSDL document indicates SOAP headers are required for the request. Displays the name and type of header.

Use the Choose Reference dialog to select a variable (of the proper type) to provide input for this request header.

Note: SOAP headers are XML and will probably be provided by you with schema-type variables.

 

Service Information (display only fields)

In the Service Information group, the builder call editor displays information about the model-based web service. If you expand Service Information, the following information is displayed.

Table 5. Web Service Call builder Service Information inputs for a WSDL-based SOAP service
Input Name Description
Reply The name and type of reply returned by the requested SOAP operation.
Service Description Service description from the WSDL document.
URL The service URL used to invoke the service.
Method Description Method description from the WSDL document.
Method Namespace Method namespace URI (namespace of target method).
SOAP Action SOAP action specified in the WSDL document for this operation

 

Advanced

Table 6. Web Service Call builder Advanced inputs for a WSDL-based SOAP service
Input Name Description
Service URL (override) You can override the service URL specified in the WSDL document by entering another service URL here.

If the WSDL is an interface WSDL with no service URL specified, it can also be supplied here.

For example, if you reference a WSDL in a development environment and expose the service in a deployed environment, the host name, application context, and so on, will most likely be different. In this case, you can enter the URL that takes into account the host name, port, and application context of the deployed environment, or supply these values via a variable that will have the correct values at runtime.

Service Host name (override) You can override the host name for the service by entering the new host name here. This can be set to localhost if using TCP tunnel for debugging.
Service Port (override) You can override the port number for the service by entering the port number here. This can be set to your tunnel port if using TCP tunnel for debugging.
Timeout (in seconds) Default is 30. Enter the number of seconds to wait for a response from the service.
Additional 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.
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 the IBM® WebSphere Portlet Factory runtime'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.
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 so that you can run the model without requiring the service 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) 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 web 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.

Parent topic: Web Service Call builder

Library | Support |