ibm-webservicesclient-bnd.xmi assembly properties for JAX applications

The ibm-webservicesclient-bnd.xmi deployment descriptor file contains information for the web services run time that is WebSphere® product-specific. This deployment descriptor file is used with Java™ API for XML-based web services.

You can configure deployment descriptors with assembly tools provided with WebSphere Application Server. Read about configuring the JAX-RPC web services client bindings in the ibm-webservicesclient-bnd.xmi deployment descriptor to learn more about configuring this deployment descriptor.

Assembly properties

The following list is a collection of supported properties and attributes that you can define for your applications.

Avoid trouble: The overriddenEndpointURI property is the only property that is applicable for Java API for XML-Based Web Services (JAX-WS) Web services.

componentNameLink: An attribute of the componentScopedRefs element. When a web service is implemented by an Enterprise JavaBeans (EJB) implementation, each <componentScopedRefs> element contains assembly properties for an individual enterprise bean. The componentNameLink attribute of the <componentScopedRefs> element identifies the enterprise bean that the assembly properties apply to by specifying the <ejb-name>. This property is used only when the web service client is an enterprise bean.
serviceRefLink: An attribute of the serviceRefs element. Specifies the link to the <service-ref-name> in the <service-ref> element in the client deployment descriptor. The client deployment descriptor is either ejb-jar.xml, web.xml or application-client.xml.
deployedWSDLFile: An attribute of the serviceRefs element is optional. Permits an alternate Web Services Description Language (WSDL) file to use other than that specified in the <wsdl-file> element of the <service-ref> element in the client deployment descriptor. If an 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 supplies a new WSDL file containing a different endpoint web address than the original WSDL file.
defaultMappings: An element that identifies which port to use for a given portType when one is not selected by the client. This element has the following attributes: portTypeNamespace, portTypeLocalName, portNamespace, portLocalName. These attributes identify which wsdl:port is used for a wsdl:portType.
syncTimeout: An attribute of the portQnameBindings element. Specifies how long, in seconds, to wait for a response from a synchronous call. The default is 300 seconds.
basicAuth: An element of the portQnameBindings element. Authenticates a service client to the service endpoint, independent of the underlying transport that includes, HTTP, HTTPS, and Java Message Service (JMS). Set the user ID and password attributes as needed.
sslConfig: An element of the portQnameBindings element. Specifies the Secure Sockets Layer (SSL) configuration of an HTTPS outbound request. The name attribute is the name of an SSL configuration entry or alias that is defined in the SSL configuration repertoire. This attribute is used only when the client is running in the WebSphere Application Server.
For WebSphere Application Server for z/OS®, some digital certificate and keyring management is required. To learn more, see the creating Secure Sockets Layer digital certificates and System Authorization Facility keyrings that applications can use to initiate HTTPS requests information.
overriddenEndpointURI: A property that specifies the final URL to which requests will be sent. When the client is run to invoke the web service, the request is sent to this property's URL, which takes precedence over the address given in the WSDL file and the client code. This property is the only property in the ibm-webservicesclient-bnd.xmi file which is applicable to JAX-WS services.

A bindings file example

The following example demonstrates 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. Read about the WSDL2Java command-line tool for Java API for XML-based Remote Procedure Call (JAX-RPC) applications to learn more about this tool.

<com.ibm.etools.webservice.wscbnd:ClientBinding xmi:version="2.0" 
xmlns:xmi="https://www.omg.org/XMI" xmlns:com.ibm.etools.webservice.wscbnd=
"https://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="https://www.com.ibm" 
portLocalName="AddressBookPort" portNamespace="https://www.com.ibm"/>
			<portQnameBindings portQnameNamespaceLink="https://www.com.ibm" 
portQnameLocalNameLink="AddressBookPort" syncTimeout="99">
				<basicAuth userid="myId" password="myPassword"/>
				<sslConfig name="mynode/DefaultSSLSettings"/>
			</portQnameBindings>
		</serviceRefs>
	</com.ibm.etools.webservice.wscbnd:ClientBinding>