Web services assembly properties

ibm-webservices-bnd.xmi properties

The ibm-webservices-bnd.xmi file is a deployment descriptor for a Web Services-enabled Web module (WAR file). It contains information for the Web services runtime that is either WebSphere product-specific or is not specified by the Web services for J2EE specification.

You can edit these properties with the WebSphere Studio Development Client for iSeries:

1. Locate the webservices.xml file in the module.
2. Double-click the webservices.xml file to open the Web Services editor.
3. Click the Bindings tab to access the Web Services Bindings editor.
4. Click the Binding Configurations tab to access the Web Services Binding Configurations editor.
5. After you edit the properties, click File --> Save to save your changes.

The following user-definable assembly properties are supported:

• wsDescNameLink
  Attribute of the wsdescBindings element that specifies the link to the corresponding <webservice-description-name> in webservices.xml. To set this property with the WebSphere Studio Development Client for iSeries, follow these steps:

  1. Click the Bindings tab.
  2. Expand the Web Service Description Bindings section.
  3. Click Add and choose the Web services description binding properties for which you want to apply the change.
  4. Click OK.

• pc-name-link
  Attribute of the pcBindings element that specifies the link to the <port-component-name> in the webservices.xml file. To set this property with the WebSphere Studio Development Client for iSeries, follow these steps:

  1. Click the Bindings tab.
  2. Expand the Port Component Binding section.
  3. Click Add.
  4. Select the port component name from the drop down list in the PC Name Link field.

• scope
  Attribute of the pcBindings element that specifies when new instances of implementation beans are created. Possible values are Request, Session, and Application. The value of scope for a deployed Web service can be changed using the administrative console:

  1. In the administrative console navigation menu, expand Applications and click Enterprise Applications.
  2. Click the name of your enterprise application.
  3. Under Additional Properties, click Web Modules.
  4. Click the name of your Web Module.
  5. Under Additional Properties, click Web Services Implementation Scope.

  To set this property for an undeployed Web service, perform the following steps in the WebSphere Studio Development Client for iSeries:

  1. Click the Bindings tab.
  2. Expand the Port Component Binding section.
  3. Click Add.
  4. Select the implementation scope name from the drop down list in the Scope field.

ibm-webservicesclient-bnd.xmi properties

The ibm-webservicesclient-bnd.xmi file contains information for the Web Services runtime that is WebSphere product-specific.

You can edit these properties with the WebSphere Studio Development Client for iSeries:

1. Locate the webservicesclient.xml file in the module.
2. Double-click the webservicesclient.xml file to open the Web Services Client editor.
3. Click the Client Binding tab to access the Web Services Client Bindings editor.
4. Click the Port Bindings tab to access the Web Services Client Port Bindings editor.
5. After you edit the properties, click File --> Save to save your changes.

Assembly properties

The following user-definable assembly properties are supported:

• componentNameLink
  Attribute of the componentScopedRefs element that specifies the link to the corresponding <component-scoped-refs> element in webservicesclient.xml file. To set this property with the WebSphere Studio Development Client for iSeries, follow these steps:

  1. Click the Client Binding tab.
  2. Expand the Component scoped references section.
  3. Click Add.
  4. Select the component scoped references defined in the webservicesclient.xml file from the list.

• serviceRefLink
  Attribute of the serviceRefs element that specifies the link to the <service-ref-name> in the webservicesclient.xml file. To set this property with the WebSphere Studio Development Client for iSeries, follow these steps:

  1. Click the Services References tab.
  2. Click Add.
  3. From the list, select the service references that are defined in the webservicesclient.xml file.

• deployedWSDLFile
  Attribute of the serviceRefs element is optional and permits an alternate WSDL file to be used other than that specified in the <wsdl-file> element of webservicesclient.xml file. If this attribute is specified, the alternate WSDL file must be packaged in the same module and must be compatible with the development WSDL file. The deployedWSDLFile property is used to supply a new WSDL file containing a different endpoint URL than the original WSDL file.

  To set this property with the WebSphere Studio Development Client for iSeries, follow these steps:

  1. Select the service references or component scoped reference that you want.
  2. Expand the Service reference details section.
  3. Click Browse on the Deployed WSDL file field.
  4. Select the new WSDL file.
  5. Click OK.

• defaultMappings element
  Identifies which port should be used for a given portType when none is explicitly selected by the client. This element has the following attributes: portTypeNamespace, portTypeLocalName, portNamespace, portLocalName. These attributes identify which wsdl:port should be used for a wsdl:portType. To edit this property with the WebSphere Studio Development Client for iSeries, follow these steps:

  1. Click Default Mappings.
  2. Click Add.
  3. Edit the entries in the new row to establish a mapping between a portType and port in the WSDL file. There can only be one entry for each portType.
  4. Click OK.

• syncTimeout
  Attribute of the portQnameBindings element that specifies how long, in seconds, to wait for a response from a synchronous call. To edit this property with the WebSphere Studio Development Client for iSeries, perform these steps:

  1. Create a Port Qualified Name Bindings for the port.
  2. Confirm that a service reference is selected in either the Component scoped references or Service references section.
  3. Expand the Port qualified name bindings section.
  4. Click Add. A new entry is added to the Port qualified name bindings list.
  5. Click the new port qualified name bindings entry. The Web Services Client Port Bindings editor opens.
  6. Expand the Port qualified name bindings details section.
  7. In the Port Namespace Link field, enter the namespace of the WSDL file port that you want to configure.
  8. In the Port Local Name Link field, enter the local name of the WSDL file port that you want to configure. The name that is displayed in the Port qualified name bindings list is the local name of the WSDL file port.
  9. Click OK.
  10. To configure the syncTimeout property, locate the Synchronization timeout field and enter the desired value.

• basicAuth
  Element of the portQnameBindings element that can be used to authenticate a service client to the service endpoint, independent of the underlying transport that includes, HTTP, HTTPS, and JMS. Set the user ID and password attributes as needed. To configure this property with the WebSphere Studio Development Client for iSeries, follow these steps:

  1. Expand the Basic authentication section.
  2. Type the desired values in the User ID and Password fields.
  3. Click OK.

• sslConfig
  Element of the portQnameBindings element that specifies the Secure Sockets Layer (SSL) configuration of an HTTPS outbound request. The name attribute is the name of a SSL configuration entry or alias defined in the SSL Configuration Repertoire.

  Note: This attribute is only used when the client is running in the WebSphere Application Server - Express for iSeries.

  To edit this property with the WebSphere Studio Development Client for iSeries, perform these steps:

  1. Expand the SSL Configuration section.
  2. Type the desired value in the Name field.
  3. Click OK.

The values of deployedWSDLFile and the defaultMappings of a deployed Web service can also be changed using the administrative console. Using application management, navigate to the Web module of the Web service application and select Web Services Client Bindings.

Example bindings files

The following examples demonstrate the spelling and position of the various attributes. You cannot cut and paste these examples because they do not contain the required ID attributes. If you add elements to a binding file template generated by the WSDL2Java command, you must confirm that each element has an ID attribute whose value is a unique string. Review the template xmi files generated by the WSDL2Java command for examples of ID strings.

Example ibm-webservices-bnd.xmi file

<com.ibm.etools.webservice.wsbnd:WSBinding xmi:version="2.0"
    xmlns:xmi="http://www.omg.org/XMI" xmlns:com.ibm.etools.webservice.wsbnd=
    "http://www.ibm.com/websphere/appserver/schemas/5.0.2/wsbnd.xmi">
  <wsdescBindings wsDescNameLink="AddressBookService">
    <pcBindings pcNameLink="AddressBook" scope="Application"/>
  </wsdescBindings>
</com.ibm.etools.webservice.wsbnd:WSBinding>

Example ibm-webservicesclient-bnd.xmi file

<com.ibm.etools.webservice.wscbnd:ClientBinding xmi:version="2.0"
    xmlns:xmi="http://www.omg.org/XMI" xmlns:com.ibm.etools.webservice.wscbnd=
    "http://www.ibm.com/websphere/appserver/schemas/5.0.2/wscbnd.xmi">
  <componentScopedRefs componentNameLink="myComponent ref"/>
  <serviceRefs serviceRefLink="myService ref" deployedWSDLFile="META-INF/wsdl/alternate.wsdl">
    <defaultMappings portTypeLocalName="AddressBook"
        portTypeNamespace="http://www.com.ibm" portLocalName="AddressBookPort"
        portNamespace="http://www.com.ibm"/>
      <portQnameBindings portQnameNamespaceLink="http://www.com.ibm"
          portQnameLocalNameLink="AddressBookPort" syncTimeout="99">
        <basicAuth userid="myId" password="myPassword"/>
        <sslConfig name="mynode/DefaultSSLSettings"/>
      </portQnameBindings>
    </serviceRefs>
  </com.ibm.etools.webservice.wscbnd:ClientBinding>