All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.ws.server.package-info Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

/**
 * 

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

* *

JAX-WS 2.0.1 Server Runtime Sequence Diagram

* Server Runtime Sequence Diagram * * *

Message Flow

*

A Web Service invocation starts with either the * {@code com.sun.xml.ws.transport.http.servlet.WSServletDelegate} * or the {@code com.sun.xml.ws.transport.http.server.ServerConnectionImpl}. * Both of these classes find the appropriate {@code com.sun.xml.ws.server.RuntimeEndpointInfo} * and invokes the {@code com.sun.xml.ws.server.Tie#handle(com.sun.xml.ws.api.server.WSConnection, * com.sun.xml.ws.spi.runtime.RuntimeEndpointInfo) Tie.handle} * method. This method first creates a {@code com.sun.pept.ept.MessageInfo MessageInfo} * used to gather information about the message to be received. A * {@code com.sun.xml.ws.server.RuntimeContext RuntimeContext} * is then created with the MessageInfo and the {@link com.sun.xml.ws.api.model.SEIModel RuntimeModel} * retrieved from the RuntimeEndpointInfo. The RuntimeContext is then * stored in the MessageInfo. The {@code com.sun.pept.ept.EPTFactory EPTFactory} * is retrieved from the {@code com.sun.xml.ws.server.EPTFactoryFactoryBase EPTFactoryFactoryBase} * and also placed in the MessagInfo. A {@code com.sun.pept.protocol.MessageDispatcher MessageDispatcher} * is then created and the receive method is invoked. There will be two * types of MessageDispatchers for JAX-WS 2.0.1, SOAPMessageDispatcher * (one for client and one for the server) and an XMLMessageDispatcher * (one for the client and one for the server).

*

The MessageDispatcher.receive method orchestrates the receiving of * a Message. The SOAPMessageDispatcher first converts the MessageInfo * to a SOAPMessage. The SOAPMessageDispatcher then does mustUnderstand * processing followed by an invocation of any handlers. The SOAPMessage * is then converted to an InternalMessage and stored in the * MessageInfo. The converting of the SOAPMessage to an InternalMessage * is done using the decoder retrieved from the EPTFactory that is * contained in the MessageInfo. Once the SOAPMessage has been converted * to an InternalMessage the endpoint implementation is invoked via * reflection from the Method stored in the MessageInfo. The return * value of the method call is then stored in the InternalMessage. An * internalMessage is then created from the MessageInfo. The SOAPEncoder * is retrieved from the EPTFactory stored in the MessageInfo. The * SOAPEncoder.toSOAPMessage is then invoked to create a SOAPMessage * from the InternalMessage. A WSConnection is then retrieved from the * MessageInfo and the SOAPMessage is returned over that WSConnection.

*


*

*

External Interactions

*

SAAJ API

*
    *
  • JAX-WS creates SAAJ jakarta.xml.soap.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.

    *
*

jakarta.xml.soap.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 * jakarta.xml.soap.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 {@link jakarta.xml.bind.JAXBContext JAXBContext}. * Handler, Dispatch in JAX-WS API provide ways for the user to specify his/her own * JAXBContext. {@code com.sun.xml.ws.encoding.jaxb.JAXBTypeSerializer} class uses all these methods.

*
    *
  • {@link jakarta.xml.bind.Marshaller#marshal(Object,XMLStreamWriter) Marshaller.marshal(Object,XMLStreamWriter)}

    *
  • {@link jakarta.xml.bind.Marshaller#marshal(Object,Result) Marshaller.marshal(Object, DomResult)}

    *
  • {@link jakarta.xml.bind.Unmarshaller#unmarshal(XMLStreamReader) Object Unmarshaller.unmarshal(XMLStreamReader)}

    *
  • {@link jakarta.xml.bind.Unmarshaller#unmarshal(Source) Object Unmarshaller.unmarshal(Source)}

    *
* The following two JAXB classes are implemented by JAX-WS to enable/implement MTOM and XOP *
    *
  • {@link jakarta.xml.bind.attachment.AttachmentMarshaller AttachmentMarshaller}

    *
  • {@link jakarta.xml.bind.attachment.AttachmentUnmarshaller 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.

*
    *
  • {@link org.glassfish.jaxb.runtime.api.Bridge#marshal(BridgeContext, Object, XMLStreamWriter) Bridge.marshal(BridgeContext, Object, XMLStreamWriter)}

    *
  • {@link org.glassfish.jaxb.runtime.api.Bridge#marshal(BridgeContext, Object, Node) Bridge.marshal(BridgeContext, Object, Node)}

    *
  • {@link org.glassfish.jaxb.runtime.api.Bridge#unmarshal(BridgeContext, XMLStreamReader) Object Bridge.unmarshal(BridgeContext, XMLStreamReader)}

    *
* **/ package com.sun.xml.ws.server; import org.glassfish.jaxb.runtime.api.BridgeContext; import javax.xml.stream.XMLStreamReader; import javax.xml.stream.XMLStreamWriter; import javax.xml.transform.Source; import javax.xml.transform.Result; import org.w3c.dom.Node;




© 2015 - 2024 Weber Informatics LLC | Privacy Policy