Web Services Addressing APIs
This product provides interfaces at the application programming level to enable application developers, including developers of Web Services Resource Framework applications, to create references to, and to target, web service resource instances. If we are a system programmer, we can use some these interfaces with the Web Services Addressing (WS-Addressing) system programming interfaces.
JAX-WS 2.1 APIs
The standard JAX-WS 2.1 APIs in this product are contained in the javax.xml.ws.wsaddressing package. Refer to the JAX-WS 2.1 API documentation for more information about these APIs.
The implementation of the standard JAX-WS 2.1 APIs in this product also contains APIs, in the com.ibm.websphere.wsaddressing.jaxws21 package. These APIs are described in more detail in the generated API documentation in this information center. These APIs allow you to achieve the following objectives by using specific classes:
- To represent endpoints that conform to the 2004/08 WS-Addressing specification, use the com.ibm.websphere.wsaddressing.jaxws21.SubmissionEndpointReference class.
- To create a SubmissionEndpointReference instance to represent 2004/08 endpoints in web services other than the one generating the endpoint reference, use the com.ibm.websphere.wsaddressing.jaxws21.SubmissionEndpointReferenceBuilder class.
- To convert EndpointReference instances created using the IBM proprietary WS-Addressing API into either W3CEndpointReference or SubmissionEndpointReference instances, use the com.ibm.websphere.wsaddressing.jaxws21.EndpointReferenceCoverter class. This class can also be used to reverse the conversion of EndpointReference instances.
- To enable WS-Addressing on clients, use the com.ibm.websphere.wsaddressing.jaxws21.SubmissionAddressingFeature class, and an annotation, @SubmissionAddressing, for enabling WS-Addressing on servers.
IBM proprietary WS-Addressing APIs
These APIs are contained in the com.ibm.websphere.wsaddressing package and are summarized in the following diagram. The diagram also shows the following classes from the JAX-WS 2.1 API: com.ibm.websphere.wsaddressing.jaxws21.EndpointReferenceConverter, javax.xml.ws.wsaddressing.W3CEndpointReference and com.ibm.websphere.wsaddressing.jaxws21.SubmissionEndpointReference.
These interfaces provide the following features:
- A mechanism for creating a com.ibm.websphere.wsaddressing.EndpointReference instance to represent a WS-Addressing endpoint reference using the com.ibm.websphere.wsaddressing.EndpointReferenceManager.createEndpointReference interface.
Deprecated feature: A deprecated class, com.ibm.websphere.wsaddressing.EndpointReferenceCoverter, for converting EndpointReference instances into deprecated classes com.ibm.websphere.wsaddressing.W3CEndpointReference or com.ibm.websphere.wsaddressing.SubmissionEndpointReferences, for use in JAX-WS applications.
These classes are deprecated in favour of the JAX-WS 2.1 classes of the same name (EndpointReferenceConverter, SubmissionEndpointReference, and W3CEndpointReference) contained in the com.ibm.websphere.wsaddressing.jaxws21 and javax.xml.ws.wsaddressing.jaxws21 packages, as shown on the diagram. depfeat
- A method, com.ibm.websphere.wsaddressing.EndpointReference.setReferenceParameter, to enable you to associate reference parameters with an EndpointReference instance.
- An interface to enable a client to configure its BindingProvider request context, or Stub or Call object, based on an EndpointReference instance. All invocations on the BindingProvider, Stub or Call object are subsequently targeted at the endpoint that is represented by the EndpointReference instance. To achieve this behavior, set the com.ibm.websphere.wsaddressing.WSAConstants.WSADDRESSING_DESTINATION_EPR property on the BindingProvider request context, or Stub or Call object, to the appropriate EndpointReference instance.
- A mechanism for acquiring individual reference parameters associated with the incoming message context, to correlate the message to a specific resource instance through the com.ibm.websphere.EndpointReferenceManager.getReferenceParameterFromMessageContext interface.
Related concepts
Web Services Addressing support Web Services Resource Framework support
Related tasks
Create stateful web services using the Web Services Resource Framework
IBM proprietary Web Services Addressing SPIs
Related information:
Generated API documentation - Application programming interfaces
JAX-WS API: http://jcp.org/aboutJava/communityprocess/mrel/jsr224/index2.html