Module com.sun.xml.ws

Package com.sun.xml.ws.client

package com.sun.xml.ws.client

This document describes the architecture of client side JAX-WS 2.0.1 runtime.

JAX-WS 2.0.1 Client Sequence Diagram

Client Sequence Diagram

JAX-WS 2.0.1 Asynchronous Invocation Sequence Diagram

Asynchronous Invocation Sequence Diagram

JAX-WS 2.0.1 Dispatch Invocation Sequence Diagram

Dispatch Invocation Sequence Diagram

Message Flow

WSServiceDelegate provides client view of a Web service. WSServiceDelegate.getPort returns an instance of com.sun.xml.ws.client.EndpointIFInvocationHandler with com.sun.pept.ept.ContactInfoList and com.sun.pept.Delegate initialized. A method invocation on the port, obtained from WebService, invokes com.sun.xml.ws.client.EndpointIFInvocationHandler#invoke. This method then creates a com.sun.pept.ept.MessageInfo and populates the data (parameters specified by the user) and metadata such as RuntimeContext, RequestContext, Message Exchange Pattern into this MessageInfo. This method then invokes com.sun.pept.Delegate#send and returns the response.

The Delegate.send method iterates through the ContactInfoList and picks up the correct com.sun.pept.ept.ContactInfo based upon the binding id of BindingProvider and sets it on the MessageInfo. After the Delegate obtains a specific ContactInfo it uses that ContactInfo to obtain a protocol-specific com.sun.pept.protocol.MessageDispatcher. There will be two types of client-side MessageDispatchers for JAX-WS 2.0.1, com.sun.xml.ws.protocol.soap.client.SOAPMessageDispatcher and com.sun.xml.ws.protocol.xml.client.XMLMessageDispatcher. The Delegate then invokes com.sun.pept.protocol.MessageDispatcher#send. The MessageDispatcher.send method makes a decision about the synchronous and asynchronous nature of the message exchange pattern and invokes separate methods accordingly.

The MessageDispatcher uses ContactInfo to obtain a com.sun.xml.ws.encoding.soap.client.SOAPXMLEncoder which converts the MessageInfo to com.sun.xml.ws.encoding.soap.internal.InternalMessage. There will be two types of client-side SOAPXMLEncoder for JAX-WS 2.0.1, SOAPXMEncoder for SOAP 1.1 and com.sun.xml.ws.encoding.soap.client.SOAP12XMLEncoder for SOAP 1.2. The MessageDispatcher invokes configured handlers and use the codec to convert the InternalMessage to a SOAPMessage. The metadata from the MessageInfo is classified into MimeHeaders of this SOAPMessage and context information for com.sun.xml.ws.api.server.WSConnection. The SOAPMessge is then written to the output stream of the WSConnection obtained from MessageInfo.

The MessageDispatcher.receive method handles the response. The SOAPMessageDispatcher extracts the SOAPMessage from the input stream of WSConnection and performs the mustUnderstand processing followed by invocation of any handlers. The MessageDispatcher uses ContactInfo to obtain a com.sun.xml.ws.encoding.soap.client.SOAPXMLDecoder which converts the SOAPMessage to InternalMessage and then InternalMessage to MessageInfo. There will be two types of client-side SOAPXMLDecoder for JAX-WS 2.0.1, SOAPXMLDencoder for SOAP 1.1 and com.sun.xml.ws.encoding.soap.client.SOAP12XMLDecoder for SOAP 1.2. The response is returned back to the client code via Delegate.

External Interactions

SAAJ API

  • JAX-WS creates SAAJ SOAPMessage from the HttpServletRequest. At present, JAX-WS reads all the bytes from the request stream and then creates SOAPMessage along with the HTTP headers.

MessageFactory(binding).createMessage(MimeHeaders, InputStream)

  • SOAPMessage parses the content from the stream including MIME data

  • com.sun.xml.ws.server.SOAPMessageDispatcher::checkHeadersPeekBody()

    SOAPMessage.getSOAPHeader() is used for mustUnderstand processing of headers. It further uses SOAPHeader.examineMustUnderstandHeaderElements(role)

    SOAPMessage.getSOAPBody().getFistChild() is used for guessing the MEP of the request

  • com.sun.xml.ws.handler.HandlerChainCaller:insertFaultMessage()

    SOAPMessage.getSOAPPart().getEnvelope() and some other SAAJ calls are made to create a fault in the SOAPMessage

  • com.sun.xml.ws.handler.LogicalMessageImpl::getPayload() interacts with SAAJ to get body from SOAPMessage

  • com.sun.xml.ws.encoding.soap.SOAPEncoder.toSOAPMessage(com.sun.xml.ws.encoding.soap.internal.InternalMessage, SOAPMessage). There is a scenario where there is SOAPMessage and a logical handler sets payload as Source. To write to the stream, SOAPMessage.writeTo() is used but before that the body needs to be updated with logical handler' Source. Need to verify if this scenario is still happening since Handler.close() is changed to take MessageContext.

  • com.sun.xml.ws.handlerSOAPMessageContextImpl.getHeaders() uses SAAJ API to get headers.

  • SOAPMessage.writeTo() is used to write response. At present, it writes into byte[] and this byte[] is written to HttpServletResponse.

JAXB API

JAX-WS RI uses the JAXB API to marshall/unmarshall user created JAXB objects with user created JAXBContext. Handler, Dispatch in JAX-WS API provide ways for the user to specify his/her own JAXBContext. com.sun.xml.ws.encoding.jaxb.JAXBTypeSerializer JAXBTypeSerializer class uses all these methods.

  • Marshaller.marshal(Object,XMLStreamWriter)

  • Marshaller.marshal(Object, DomResult)

  • Object Unmarshaller.unmarshal(XMLStreamReader)

  • Object Unmarshaller.unmarshal(Source)

The following two JAXB classes are implemented by JAX-WS to enable/implement MTOM and XOP

  • AttachmentMarshaller

  • AttachmentUnmarshaller

JAXB Runtime-API (private contract)

JAX-WS RI uses these private API for serialization/deserialization purposes. This private API is used to serialize/deserialize method parameters at the time of JAXBTypeSerializer class uses all these methods.

  • Bridge.marshal(BridgeContext, Object, XMLStreamWriter)

  • Bridge.marshal(BridgeContext, Object, Node)

  • Object Bridge.unmarshal(BridgeContext, XMLStreamReader)