org.apache.axis2.saaj
Class SOAPMessageImpl

java.lang.Object
  extended byjavax.xml.soap.SOAPMessage
      extended byorg.apache.axis2.saaj.SOAPMessageImpl

public class SOAPMessageImpl
extends javax.xml.soap.SOAPMessage


Field Summary
 
Fields inherited from class javax.xml.soap.SOAPMessage
CHARACTER_SET_ENCODING, WRITE_XML_DECLARATION
 
Constructor Summary
SOAPMessageImpl(java.lang.Object initialContents)
           
SOAPMessageImpl(java.lang.Object initialContents, boolean bodyInStream, javax.xml.soap.MimeHeaders headers)
           
 
Method Summary
 void addAttachmentPart(javax.xml.soap.AttachmentPart attachmentpart)
          Adds the given AttachmentPart object to this SOAPMessage object.
 int countAttachments()
          Gets a count of the number of attachments in this message.
 javax.xml.soap.AttachmentPart createAttachmentPart()
          Creates a new empty AttachmentPart object.
 java.util.Iterator getAttachments()
          Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.
 java.util.Iterator getAttachments(javax.xml.soap.MimeHeaders headers)
          Retrieves all the AttachmentPart objects that have header entries that match the specified headers.
 java.lang.String getContentDescription()
          Retrieves a description of this SOAPMessage object's content.
 javax.xml.soap.MimeHeaders getMimeHeaders()
          Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.
 java.lang.Object getProperty(java.lang.String property)
          Retrieves value of the specified property.
 javax.xml.soap.SOAPBody getSOAPBody()
          Gets the SOAP Body contained in this SOAPMessage object.
 javax.xml.soap.SOAPHeader getSOAPHeader()
          Gets the SOAP Header contained in this SOAPMessage object.
 javax.xml.soap.SOAPPart getSOAPPart()
          Gets the SOAP part of this SOAPMessage object.
 void removeAllAttachments()
          Removes all AttachmentPart objects that have been added to this SOAPMessage object.
 void saveChanges()
          Updates this SOAPMessage object with all the changes that have been made to it.
 boolean saveRequired()
          Indicates whether this SOAPMessage object has had the method saveChanges called on it.
 void setContentDescription(java.lang.String description)
          Sets the description of this SOAPMessage object's content with the given description.
 void setProperty(java.lang.String property, java.lang.Object value)
          Associates the specified value with the specified property.
 void writeTo(java.io.OutputStream out)
          Writes this SOAPMessage object to the given output stream.
 
Methods inherited from class javax.xml.soap.SOAPMessage
createAttachmentPart, createAttachmentPart
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SOAPMessageImpl

public SOAPMessageImpl(java.lang.Object initialContents)

SOAPMessageImpl

public SOAPMessageImpl(java.lang.Object initialContents,
                       boolean bodyInStream,
                       javax.xml.soap.MimeHeaders headers)
Method Detail

getContentDescription

public java.lang.String getContentDescription()
Retrieves a description of this SOAPMessage object's content.

Returns:
a String describing the content of this message or null if no description has been set
See Also:
setContentDescription(java.lang.String)

setContentDescription

public void setContentDescription(java.lang.String description)
Sets the description of this SOAPMessage object's content with the given description.

Parameters:
description - a String describing the content of this message
See Also:
getContentDescription()

getSOAPPart

public javax.xml.soap.SOAPPart getSOAPPart()
Description copied from class: javax.xml.soap.SOAPMessage
Gets the SOAP part of this SOAPMessage object.

If a SOAPMessage object contains one or more attachments, the SOAP Part must be the first MIME body part in the message.

Returns:
the SOAPPart object for this SOAPMessage object
See Also:
SOAPMessage.getSOAPPart()

getSOAPBody

public javax.xml.soap.SOAPBody getSOAPBody()
                                    throws javax.xml.soap.SOAPException
Description copied from class: javax.xml.soap.SOAPMessage
Gets the SOAP Body contained in this SOAPMessage object.

Returns:
the SOAPBody object contained by this SOAPMessage object
Throws:
javax.xml.soap.SOAPException - if the SOAP Body does not exist or cannot be retrieved

getSOAPHeader

public javax.xml.soap.SOAPHeader getSOAPHeader()
                                        throws javax.xml.soap.SOAPException
Description copied from class: javax.xml.soap.SOAPMessage
Gets the SOAP Header contained in this SOAPMessage object.

Returns:
the SOAPHeader object contained by this SOAPMessage object
Throws:
javax.xml.soap.SOAPException - if the SOAP Header does not exist or cannot be retrieved

setProperty

public void setProperty(java.lang.String property,
                        java.lang.Object value)
                 throws javax.xml.soap.SOAPException
Description copied from class: javax.xml.soap.SOAPMessage
Associates the specified value with the specified property. If there was already a value associated with this property, the old value is replaced.

The valid property names include WRITE_XML_DECLARATION and CHARACTER_SET_ENCODING. All of these standard SAAJ properties are prefixed by "javax.xml.soap". Vendors may also add implementation specific properties. These properties must be prefixed with package names that are unique to the vendor.

Setting the property WRITE_XML_DECLARATION to "true" will cause an XML Declaration to be written out at the start of the SOAP message. The default value of "false" suppresses this declaration.

The property CHARACTER_SET_ENCODING defaults to the value "utf-8" which causes the SOAP message to be encoded using UTF-8. Setting CHARACTER_SET_ENCODING to "utf-16" causes the SOAP message to be encoded using UTF-16.

Some implementations may allow encodings in addition to UTF-8 and UTF-16. Refer to your vendor's documentation for details.

Parameters:
property - the property with which the specified value is to be associated
value - the value to be associated with the specified property
Throws:
javax.xml.soap.SOAPException - if the property name is not recognized

getProperty

public java.lang.Object getProperty(java.lang.String property)
                             throws javax.xml.soap.SOAPException
Description copied from class: javax.xml.soap.SOAPMessage
Retrieves value of the specified property.

Parameters:
property - the name of the property to retrieve
Returns:
the value of the property or null if no such property exists
Throws:
javax.xml.soap.SOAPException - if the property name is not recognized

removeAllAttachments

public void removeAllAttachments()
Description copied from class: javax.xml.soap.SOAPMessage
Removes all AttachmentPart objects that have been added to this SOAPMessage object.

This method does not touch the SOAP part.

See Also:
SOAPMessage.removeAllAttachments()

countAttachments

public int countAttachments()
Description copied from class: javax.xml.soap.SOAPMessage
Gets a count of the number of attachments in this message. This count does not include the SOAP part.

Returns:
the number of AttachmentPart objects that are part of this SOAPMessage object
See Also:
SOAPMessage.countAttachments()

getAttachments

public java.util.Iterator getAttachments()
Description copied from class: javax.xml.soap.SOAPMessage
Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.

Returns:
an iterator over all the attachments in this message
See Also:
SOAPMessage.getAttachments()

getAttachments

public java.util.Iterator getAttachments(javax.xml.soap.MimeHeaders headers)
Description copied from class: javax.xml.soap.SOAPMessage
Retrieves all the AttachmentPart objects that have header entries that match the specified headers. Note that a returned attachment could have headers in addition to those specified.

Parameters:
headers - a MimeHeaders object containing the MIME headers for which to search
Returns:
an iterator over all attachments that have a header that matches one of the given headers
See Also:
SOAPMessage.getAttachments(javax.xml.soap.MimeHeaders)

addAttachmentPart

public void addAttachmentPart(javax.xml.soap.AttachmentPart attachmentpart)
Description copied from class: javax.xml.soap.SOAPMessage
Adds the given AttachmentPart object to this SOAPMessage object. An AttachmentPart object must be created before it can be added to a message.

Parameters:
attachmentpart - an AttachmentPart object that is to become part of this SOAPMessage object
See Also:
SOAPMessage.addAttachmentPart(javax.xml.soap.AttachmentPart)

createAttachmentPart

public javax.xml.soap.AttachmentPart createAttachmentPart()
Description copied from class: javax.xml.soap.SOAPMessage
Creates a new empty AttachmentPart object. Note that the method addAttachmentPart must be called with this new AttachmentPart object as the parameter in order for it to become an attachment to this SOAPMessage object.

Returns:
a new AttachmentPart object that can be populated and added to this SOAPMessage object
See Also:
SOAPMessage.createAttachmentPart()

getMimeHeaders

public javax.xml.soap.MimeHeaders getMimeHeaders()
Description copied from class: javax.xml.soap.SOAPMessage
Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.

Returns:
a MimeHeaders object containing the MimeHeader objects
See Also:
SOAPMessage.getMimeHeaders()

saveChanges

public void saveChanges()
                 throws javax.xml.soap.SOAPException
Description copied from class: javax.xml.soap.SOAPMessage
Updates this SOAPMessage object with all the changes that have been made to it. This method is called automatically when a message is sent or written to by the methods ProviderConnection.send, SOAPConnection.call, or SOAPMessage.writeTo. However, if changes are made to a message that was received or to one that has already been sent, the method saveChanges needs to be called explicitly in order to save the changes. The method saveChanges also generates any changes that can be read back (for example, a MessageId in profiles that support a message id). All MIME headers in a message that is created for sending purposes are guaranteed to have valid values only after saveChanges has been called.

In addition, this method marks the point at which the data from all constituent AttachmentPart objects are pulled into the message.

Throws:
javax.xml.soap.SOAPException - if there was a problem saving changes to this message.
See Also:
SOAPMessage.saveChanges()

saveRequired

public boolean saveRequired()
Description copied from class: javax.xml.soap.SOAPMessage
Indicates whether this SOAPMessage object has had the method saveChanges called on it.

Returns:
true if saveChanges has been called on this message at least once; false otherwise.
See Also:
SOAPMessage.saveRequired()

writeTo

public void writeTo(java.io.OutputStream out)
             throws javax.xml.soap.SOAPException,
                    java.io.IOException
Description copied from class: javax.xml.soap.SOAPMessage
Writes this SOAPMessage object to the given output stream. The externalization format is as defined by the SOAP 1.1 with Attachments specification.

If there are no attachments, just an XML stream is written out. For those messages that have attachments, writeTo writes a MIME-encoded byte stream.

Parameters:
out - the OutputStream object to which this SOAPMessage object will be written
Throws:
javax.xml.soap.SOAPException - if there was a problem in externalizing this SOAP message
java.io.IOException - if an I/O error occurs
See Also:
SOAPMessage.writeTo(java.io.OutputStream)