Module com.sun.xml.ws
Package com.sun.xml.ws.message.jaxb

Class JAXBMessage

java.lang.Object
com.sun.xml.ws.api.message.Message
com.sun.xml.ws.message.AbstractMessageImpl
com.sun.xml.ws.message.jaxb.JAXBMessage
All Implemented Interfaces:
StreamingSOAP
public final class JAXBMessage extends AbstractMessageImpl implements StreamingSOAP
Message backed by a JAXB bean.
Author:
Kohsuke Kawaguchi

  • Constructor Details

    • JAXBMessage

      public JAXBMessage(JAXBMessage that)
      Copy constructor.

  • Method Details

    • create

      public static Message create(BindingContext context, Object jaxbObject, SOAPVersion soapVersion, MessageHeaders headers, AttachmentSet attachments)

    • create

      public static Message create(BindingContext context, Object jaxbObject, SOAPVersion soapVersion)
      Creates a Message backed by a JAXB bean.
      Parameters:
      context - The JAXBContext to be used for marshalling.
      jaxbObject - The JAXB object that represents the payload. must not be null. This object must be bound to an element (which means it either is a JAXBElement or an instanceof a class with XmlRootElement).
      soapVersion - The SOAP version of the message. Must not be null.

    • create

      @Deprecated public static Message create(jakarta.xml.bind.JAXBContext context, Object jaxbObject, SOAPVersion soapVersion)
      Deprecated.

    • createRaw

      @Deprecated public static Message createRaw(jakarta.xml.bind.JAXBContext context, Object jaxbObject, SOAPVersion soapVersion)
      Deprecated.
      For use when creating a Dispatch object with an unknown JAXB implementation for he JAXBContext parameter.

    • create

      public static Message create(XMLBridge bridge, Object jaxbObject, SOAPVersion soapVer)
      Creates a Message backed by a JAXB bean.
      Parameters:
      bridge - Specify the payload tag name and how jaxbObject is bound.

    • hasHeaders

      public boolean hasHeaders()
      Description copied from class: Message
      Returns true if headers are present in the message.
      Specified by:
      hasHeaders in class Message
      Returns:
      true if headers are present.

    • getHeaders

      public MessageHeaders getHeaders()
      Description copied from class: Message
      Gets all the headers of this message.

      Implementation Note

      Message implementation is allowed to defer the construction of MessageHeaders object. So if you only want to check for the existence of any header element, use Message.hasHeaders().

      Specified by:
      getHeaders in class Message
      Returns:
      always return the same non-null object.

    • getPayloadLocalPart

      public String getPayloadLocalPart()
      Description copied from class: Message
      Gets the local name of the payload element.
      Specified by:
      getPayloadLocalPart in class Message
      Returns:
      null if a Message doesn't have any payload.

    • getPayloadNamespaceURI

      public String getPayloadNamespaceURI()
      Description copied from class: Message
      Gets the namespace URI of the payload element.
      Specified by:
      getPayloadNamespaceURI in class Message
      Returns:
      null if a Message doesn't have any payload.

    • hasPayload

      public boolean hasPayload()
      Description copied from class: Message
      Returns true if a Message has a payload.

      A message without a payload is a SOAP message that looks like: 

      
 <S:Envelope>
   <S:Header>
     ...
   </S:Header>
   <S:Body />
 </S:Envelope>
      Specified by:
      hasPayload in class Message

    • readPayloadAsSource

      public Source readPayloadAsSource()
      Description copied from class: Message
      Returns the payload as a Source object. This consumes the message.
      Specified by:
      readPayloadAsSource in class Message
      Returns:
      if there's no payload, this method returns null.

    • readPayloadAsJAXB

      public <T> T readPayloadAsJAXB(jakarta.xml.bind.Unmarshaller unmarshaller) throws jakarta.xml.bind.JAXBException
      Description copied from class: Message
      Reads the payload as a JAXB object by using the given unmarshaller. This consumes the message.
      Overrides:
      readPayloadAsJAXB in class AbstractMessageImpl
      Throws:
      jakarta.xml.bind.JAXBException - If JAXB reports an error during the processing.

    • readPayload

      public XMLStreamReader readPayload() throws XMLStreamException
      Description copied from class: Message
      Reads the payload as a XMLStreamReader This consumes the message. The caller is encouraged to call XMLStreamReaderFactory.recycle(XMLStreamReader) when finished using the instance.
      Specified by:
      readPayload in interface StreamingSOAP
      Specified by:
      readPayload in class Message
      Returns:
      If there's no payload, this method returns null. Otherwise always non-null valid XMLStreamReader that points to the payload tag name.
      Throws:
      XMLStreamException

    • writePayloadTo

      protected void writePayloadTo(ContentHandler contentHandler, ErrorHandler errorHandler, boolean fragment) throws SAXException
      Writes the payload as SAX events.
      Specified by:
      writePayloadTo in class AbstractMessageImpl
      fragment - if true, this method will fire SAX events without start/endDocument events, suitable for embedding this into a bigger SAX event sequence. if false, this method generaets a completely SAX event sequence on its own.
      Throws:
      SAXException

    • writePayloadTo

      public void writePayloadTo(XMLStreamWriter sw) throws XMLStreamException
      Description copied from class: Message
      Writes the payload to StAX. This method writes just the payload of the message to the writer. This consumes the message. The implementation will not write XMLStreamWriter.writeStartDocument() nor XMLStreamWriter.writeEndDocument()

      If there's no payload, this method is no-op.

      Specified by:
      writePayloadTo in interface StreamingSOAP
      Specified by:
      writePayloadTo in class Message
      Throws:
      XMLStreamException - If the XMLStreamWriter reports an error, or some other errors happen during the processing.

    • copy

      public Message copy()
      Description copied from class: Message
      Creates a copy of a Message.

      This method creates a new Message whose header/payload/attachments/properties are identical to this Message. Once created, the created Message and the original Message behaves independently --- adding header/ attachment to one Message doesn't affect another Message at all.

      This method does NOT consume a message.

      To enable efficient copy operations, there's a few restrictions on how copied message can be used.

      1. The original and the copy may not be used concurrently by two threads (this allows two Messages to share some internal resources, such as JAXB marshallers.) Note that it's OK for the original and the copy to be processed by two threads, as long as they are not concurrent.
      2. The copy has the same 'life scope' as the original (this allows shallower copy, such as JAXB beans wrapped in JAXBMessage.)

      A 'life scope' of a message created during a message processing in a pipeline is until a pipeline processes the next message. A message cannot be kept beyond its life scope. (This experimental design is to allow message objects to be reused --- feedback appreciated.)

      Design Rationale

      Since a Message body is read-once, sometimes (such as when you do fail-over, or WS-RM) you need to create an identical copy of a Message.

      The actual copy operation depends on the layout of the data in memory, hence it's best to be done by the Message implementation itself.

      The restrictions placed on the use of copied Message can be relaxed if necessary, but it will make the copy method more expensive.

      IMPORTANT

      WHEN YOU IMPLEMENT OR CHANGE A #copy() METHOD, YOU MUST USE THE Message.copyFrom(com.sun.xml.ws.api.message.Message) METHOD IN THE IMPLEMENTATION.

      Specified by:
      copy in class Message

    • readEnvelope

      public XMLStreamReader readEnvelope()
      Specified by:
      readEnvelope in interface StreamingSOAP

    • isPayloadStreamReader

      public boolean isPayloadStreamReader()
      Specified by:
      isPayloadStreamReader in interface StreamingSOAP

    • getPayloadQName

      public QName getPayloadQName()
      Specified by:
      getPayloadQName in interface StreamingSOAP

    • readToBodyStarTag

      public XMLStreamReader readToBodyStarTag()
      Specified by:
      readToBodyStarTag in interface StreamingSOAP