File	Doc	Category	Size	Date	Package
SOAPMessage.java	API Doc	Java SE 6 API	19777	Tue Jun 10 00:27:10 BST 2008	javax.xml.soap

SOAPMessage

• java.lang.Object

SOAPPart sp = message.getSOAPPart();
SOAPEnvelope se = sp.getEnvelope();
SOAPBody sb = se.getBody();
SOAPHeader sh = se.getHeader();

Fields Summary
public static final String	CHARACTER_SET_ENCODING Specifies the character type encoding for the SOAP Message. Valid values include "utf-8" and "utf-16". See vendor documentation for additional supported values. The default is "utf-8".
public static final String	WRITE_XML_DECLARATION Specifies whether the SOAP Message will contain an XML declaration when it is sent. The only valid values are "true" and "false". The default is "false".

Constructors Summary

Methods Summary
public abstract void	addAttachmentPart(javax.xml.soap.AttachmentPart AttachmentPart) Adds the given AttachmentPart object to this SOAPMessage object. An AttachmentPart object must be created before it can be added to a message. param AttachmentPart an AttachmentPart object that is to become part of this SOAPMessage object exception IllegalArgumentException
public abstract int	countAttachments() Gets a count of the number of attachments in this message. This count does not include the SOAP part. return the number of AttachmentPart objects that are part of this SOAPMessage object
public abstract javax.xml.soap.AttachmentPart	createAttachmentPart() 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. return a new AttachmentPart object that can be populated and added to this SOAPMessage object
public javax.xml.soap.AttachmentPart	createAttachmentPart(javax.activation.DataHandler dataHandler) Creates an AttachmentPart object and populates it using the given DataHandler object. param dataHandler the javax.activation.DataHandler object that will generate the content for this SOAPMessage object return a new AttachmentPart object that contains data generated by the given DataHandler object exception IllegalArgumentException if there was a problem with the specified DataHandler object see javax.activation.DataHandler see javax.activation.DataContentHandler AttachmentPart attachment = createAttachmentPart(); attachment.setDataHandler(dataHandler); return attachment;
public javax.xml.soap.AttachmentPart	createAttachmentPart(java.lang.Object content, java.lang.String contentType) Creates an AttachmentPart object and populates it with the specified data of the specified content type. The type of the Object should correspond to the value given for the Content-Type. param content an Object containing the content for the AttachmentPart object to be created param contentType a String object giving the type of content; examples are "text/xml", "text/plain", and "image/jpeg" return a new AttachmentPart object that contains the given data exception IllegalArgumentException may be thrown if the contentType does not match the type of the content object, or if there was no DataContentHandler object for the given content object see javax.activation.DataHandler see javax.activation.DataContentHandler AttachmentPart attachment = createAttachmentPart(); attachment.setContent(content, contentType); return attachment;
public abstract javax.xml.soap.AttachmentPart	getAttachment(javax.xml.soap.SOAPElement element) Returns an AttachmentPart object that is associated with an attachment that is referenced by this SOAPElement or null if no such attachment exists. References can be made via an href attribute as described in {@link SOAP Messages with Attachments}, or via a single Text child node containing a URI as described in the WS-I Attachments Profile 1.0 for elements of schema type ref:swaRef({@link ref:swaRef}). These two mechanisms must be supported. The support for references via href attribute also implies that this method should also be supported on an element that is an xop:Include element ( {@link XOP}). other reference mechanisms may be supported by individual implementations of this standard. Contact your vendor for details. param element The SOAPElement containing the reference to an Attachment return the referenced AttachmentPart or null if no such AttachmentPart exists or no reference can be found in this SOAPElement. throws SOAPException if there is an error in the attempt to access the attachment since SAAJ 1.3
public abstract java.util.Iterator	getAttachments() Retrieves all the AttachmentPart objects that are part of this SOAPMessage object. return an iterator over all the attachments in this message
public abstract java.util.Iterator	getAttachments(javax.xml.soap.MimeHeaders headers) 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. param headers a MimeHeaders object containing the MIME headers for which to search return an iterator over all attachments that have a header that matches one of the given headers
public abstract java.lang.String	getContentDescription() Retrieves a description of this SOAPMessage object's content. return a String describing the content of this message or null if no description has been set see #setContentDescription
public abstract javax.xml.soap.MimeHeaders	getMimeHeaders() Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion. return a MimeHeaders object containing the MimeHeader objects
public java.lang.Object	getProperty(java.lang.String property) Retrieves value of the specified property. param property the name of the property to retrieve return the value associated with the named property or null if no such property exists. exception SOAPException if the property name is not recognized. since SAAJ 1.2 throw new UnsupportedOperationException("getProperty must be overridden by all subclasses of SOAPMessage");
public javax.xml.soap.SOAPBody	getSOAPBody() Gets the SOAP Body contained in this SOAPMessage object. return the SOAPBody object contained by this SOAPMessage object exception SOAPException if the SOAP Body does not exist or cannot be retrieved since SAAJ 1.2 throw new UnsupportedOperationException("getSOAPBody must be overridden by all subclasses of SOAPMessage");
public javax.xml.soap.SOAPHeader	getSOAPHeader() Gets the SOAP Header contained in this SOAPMessage object. return the SOAPHeader object contained by this SOAPMessage object exception SOAPException if the SOAP Header does not exist or cannot be retrieved since SAAJ 1.2 throw new UnsupportedOperationException("getSOAPHeader must be overridden by all subclasses of SOAPMessage");
public abstract javax.xml.soap.SOAPPart	getSOAPPart() Gets the SOAP part of this SOAPMessage object. SOAPMessage object contains one or more attachments, the SOAP Part must be the first MIME body part in the message. return the SOAPPart object for this SOAPMessage object
public abstract void	removeAllAttachments() Removes all AttachmentPart objects that have been added to this SOAPMessage object. This method does not touch the SOAP part.
public abstract void	removeAttachments(javax.xml.soap.MimeHeaders headers) Removes all the AttachmentPart objects that have header entries that match the specified headers. Note that the removed attachment could have headers in addition to those specified. param headers a MimeHeaders object containing the MIME headers for which to search since SAAJ 1.3
public abstract void	saveChanges() Updates this SOAPMessage object with all the changes that have been made to it. This method is called automatically when {@link SOAPMessage#writeTo(OutputStream)} is called. 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. exception SOAPException if there was a problem saving changes to this message.
public abstract boolean	saveRequired() Indicates whether this SOAPMessage object needs to have the method saveChanges called on it. return true if saveChanges needs to be called; false otherwise.
public abstract void	setContentDescription(java.lang.String description) Sets the description of this SOAPMessage object's content with the given description. param description a String describing the content of this message see #getContentDescription
public void	setProperty(java.lang.String property, java.lang.Object value) 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 {@link SOAPMessage#WRITE_XML_DECLARATION} and {@link SOAPMessage#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. param property the property with which the specified value is to be associated. param value the value to be associated with the specified property exception SOAPException if the property name is not recognized. since SAAJ 1.2 throw new UnsupportedOperationException("setProperty must be overridden by all subclasses of SOAPMessage");
public abstract void	writeTo(java.io.OutputStream out) 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. Note that this method does not write the transport-specific MIME Headers of the Message param out the OutputStream object to which this SOAPMessage object will be written exception IOException if an I/O error occurs exception SOAPException if there was a problem in externalizing this SOAP message