Spring Web Services Framework

org.springframework.ws.soap.saaj
Class SaajSoapMessage

java.lang.Object
  extended by org.springframework.ws.mime.AbstractMimeMessage
      extended by org.springframework.ws.soap.AbstractSoapMessage
          extended by org.springframework.ws.soap.saaj.SaajSoapMessage
All Implemented Interfaces:
FaultAwareWebServiceMessage, MimeMessage, SoapMessage, WebServiceMessage

public class SaajSoapMessage
extends AbstractSoapMessage

SAAJ-specific implementation of the SoapMessage interface. Created via the SaajSoapMessageFactory, wraps a SOAPMessage.

Since:
1.0.0
Author:
Arjen Poutsma
See Also:
SOAPMessage

Constructor Summary
SaajSoapMessage(SOAPMessage soapMessage)
          Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.
SaajSoapMessage(SOAPMessage soapMessage, boolean langAttributeOnSoap11FaultString)
          Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.
SaajSoapMessage(SOAPMessage soapMessage, boolean langAttributeOnSoap11FaultString, MessageFactory messageFactory)
          Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.
SaajSoapMessage(SOAPMessage soapMessage, MessageFactory messageFactory)
          Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.
 
Method Summary
 Attachment addAttachment(String contentId, DataHandler dataHandler)
          Add an attachment to the message, taking the content from a DataHandler.
 boolean convertToXopPackage()
          Turns this message into a XOP package.
 Attachment getAttachment(String contentId)
          Returns the Attachment with the specified content Id.
 Iterator<Attachment> getAttachments()
          Returns an Iterator over all Attachment objects that are part of this message.
 Document getDocument()
          Returns this message as a Document.
 SoapEnvelope getEnvelope()
          Returns the SoapEnvelope associated with this SoapMessage.
protected  org.springframework.ws.soap.saaj.SaajImplementation getImplementation()
           
 SOAPMessage getSaajMessage()
          Return the SAAJ SOAPMessage that this SaajSoapMessage is based on.
 String getSoapAction()
          Get the SOAP Action for this message, or null if not present.
 boolean isXopPackage()
          Indicates whether this message is a XOP package.
 void setDocument(Document document)
          Sets the contents of the message to the given Document.
 void setSaajMessage(SOAPMessage soapMessage)
          Sets the SAAJ SOAPMessage that this SaajSoapMessage is based on.
 void setSoapAction(String soapAction)
          Sets the SOAP Action for this message.
 String toString()
           
 void writeTo(OutputStream outputStream)
          Writes the entire message to the given output stream.
 
Methods inherited from class org.springframework.ws.soap.AbstractSoapMessage
getFaultReason, getPayloadResult, getPayloadSource, getSoapBody, getSoapHeader, getVersion, hasFault
 
Methods inherited from class org.springframework.ws.mime.AbstractMimeMessage
addAttachment, addAttachment
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.springframework.ws.mime.MimeMessage
addAttachment, addAttachment
 

Constructor Detail

SaajSoapMessage

public SaajSoapMessage(SOAPMessage soapMessage)
Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.

Parameters:
soapMessage - the SAAJ SOAPMessage

SaajSoapMessage

public SaajSoapMessage(SOAPMessage soapMessage,
                       MessageFactory messageFactory)
Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.

Parameters:
soapMessage - the SAAJ SOAPMessage
messageFactory - the SAAJ message factory

SaajSoapMessage

public SaajSoapMessage(SOAPMessage soapMessage,
                       boolean langAttributeOnSoap11FaultString)
Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.

Parameters:
soapMessage - the SAAJ SOAPMessage
langAttributeOnSoap11FaultString - whether a xml:lang attribute is allowed on SOAP 1.1 <faultstring> elements

SaajSoapMessage

public SaajSoapMessage(SOAPMessage soapMessage,
                       boolean langAttributeOnSoap11FaultString,
                       MessageFactory messageFactory)
Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.

Parameters:
soapMessage - the SAAJ SOAPMessage
langAttributeOnSoap11FaultString - whether a xml:lang attribute is allowed on SOAP 1.1 <faultstring> elements
messageFactory - the message factory
Method Detail

getSaajMessage

public SOAPMessage getSaajMessage()
Return the SAAJ SOAPMessage that this SaajSoapMessage is based on.


setSaajMessage

public void setSaajMessage(SOAPMessage soapMessage)
Sets the SAAJ SOAPMessage that this SaajSoapMessage is based on.


getEnvelope

public SoapEnvelope getEnvelope()
Description copied from interface: SoapMessage
Returns the SoapEnvelope associated with this SoapMessage.


getSoapAction

public String getSoapAction()
Description copied from interface: SoapMessage
Get the SOAP Action for this message, or null if not present.

Returns:
the SOAP Action.

setSoapAction

public void setSoapAction(String soapAction)
Description copied from interface: SoapMessage
Sets the SOAP Action for this message.

Parameters:
soapAction - the SOAP Action.

getDocument

public Document getDocument()
Description copied from interface: SoapMessage
Returns this message as a Document. Depending on the underlying implementation, this Document may be 'live' or not.

Returns:
this soap message as a DOM document

setDocument

public void setDocument(Document document)
Description copied from interface: SoapMessage
Sets the contents of the message to the given Document.

Parameters:
document - the soap message as a DOM document

writeTo

public void writeTo(OutputStream outputStream)
             throws IOException
Description copied from interface: WebServiceMessage
Writes the entire message to the given output stream.

If the given stream is an instance of TransportOutputStream, the corresponding headers will be written as well.

Parameters:
outputStream - the stream to write to
Throws:
IOException - if an I/O exception occurs

isXopPackage

public boolean isXopPackage()
Description copied from interface: MimeMessage
Indicates whether this message is a XOP package.

Returns:
true when the constraints specified in Identifying XOP Documents are met.
See Also:
XOP Packages

convertToXopPackage

public boolean convertToXopPackage()
Description copied from interface: MimeMessage
Turns this message into a XOP package.

Returns:
true when the message is a XOP package
See Also:
XOP Packages

getAttachments

public Iterator<Attachment> getAttachments()
                                    throws AttachmentException
Description copied from interface: MimeMessage
Returns an Iterator over all Attachment objects that are part of this message.

Returns:
an iterator over all attachments
Throws:
AttachmentException - in case of errors
See Also:
Attachment

getAttachment

public Attachment getAttachment(String contentId)
Description copied from interface: MimeMessage
Returns the Attachment with the specified content Id.

Returns:
the attachment with the specified content id; or null if it cannot be found

addAttachment

public Attachment addAttachment(String contentId,
                                DataHandler dataHandler)
Description copied from interface: MimeMessage
Add an attachment to the message, taking the content from a DataHandler.

dataHandler - the data handler to take the content from
Returns:
the added attachment

getImplementation

protected final org.springframework.ws.soap.saaj.SaajImplementation getImplementation()

toString

public String toString()
Overrides:
toString in class Object

Spring Web Services Framework

Copyright © 2005-2013 The Spring Web Services Framework. All Rights Reserved.