org.apache.axis2.saaj

Class SOAPMessageImpl

java.lang.Object

javax.xml.soap.SOAPMessage

org.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

Constructors

Constructor and Description
SOAPMessageImpl(java.io.InputStream inputstream, javax.xml.soap.MimeHeaders mimeHeaders, boolean processMTOM)
SOAPMessageImpl(SOAPEnvelopeImpl soapEnvelope)

Method Summary

Modifier and Type	Method and Description
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.
javax.xml.soap.AttachmentPart	getAttachment(javax.xml.soap.SOAPElement soapelement) Returns an AttachmentPart object that is associated with an attachment that is referenced by this SOAPElement or null if no such attachment exists.
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	removeAttachments(javax.xml.soap.MimeHeaders headers) Removes all the AttachmentPart objects that have header entries that match the specified headers.
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	setSaveRequired()
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(SOAPEnvelopeImpl soapEnvelope)

SOAPMessageImpl

public SOAPMessageImpl(java.io.InputStream inputstream,
                       javax.xml.soap.MimeHeaders mimeHeaders,
                       boolean processMTOM)
                throws javax.xml.soap.SOAPException

Throws:

javax.xml.soap.SOAPException

Method Detail

getContentDescription

public java.lang.String getContentDescription()

Retrieves a description of this SOAPMessage object's content.

Specified by:

getContentDescription in class javax.xml.soap.SOAPMessage

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.

Specified by:

setContentDescription in class javax.xml.soap.SOAPMessage

Parameters:

description - a String describing the content of this message

See Also:

getContentDescription()

getSOAPPart

public javax.xml.soap.SOAPPart getSOAPPart()

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.

Specified by:

getSOAPPart in class javax.xml.soap.SOAPMessage

Returns:

the SOAPPart object for this SOAPMessage object

removeAllAttachments

public void removeAllAttachments()

Removes all AttachmentPart objects that have been added to this SOAPMessage object.

This method does not touch the SOAP part.

Specified by:

removeAllAttachments in class javax.xml.soap.SOAPMessage

countAttachments

public int countAttachments()

Gets a count of the number of attachments in this message. This count does not include the SOAP part.

Specified by:

countAttachments in class javax.xml.soap.SOAPMessage

Returns:

the number of AttachmentPart objects that are part of this SOAPMessage object

getAttachments

public java.util.Iterator getAttachments()

Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.

Specified by:

getAttachments in class javax.xml.soap.SOAPMessage

Returns:

an iterator over all the attachments in this message

getAttachments

public 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.

Specified by:

getAttachments in class javax.xml.soap.SOAPMessage

Parameters:

headers - a MimeHeaders object containing the MIME headers for which to search

Returns:

an iterator over all attachments(AttachmentPart) that have a header that matches one of the given headers

addAttachmentPart

public 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.

Specified by:

addAttachmentPart in class javax.xml.soap.SOAPMessage

Parameters:

attachmentPart - an AttachmentPart object that is to become part of this SOAPMessage object

Throws:

java.lang.IllegalArgumentException

createAttachmentPart

public 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.

Specified by:

createAttachmentPart in class javax.xml.soap.SOAPMessage

Returns:

a new AttachmentPart object that can be populated and added to this SOAPMessage object

getMimeHeaders

public javax.xml.soap.MimeHeaders getMimeHeaders()

Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.

Specified by:

getMimeHeaders in class javax.xml.soap.SOAPMessage

Returns:

a MimeHeaders object containing the MimeHeader objects

saveChanges

public void saveChanges()
                 throws javax.xml.soap.SOAPException

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.

Specified by:

saveChanges in class javax.xml.soap.SOAPMessage

Throws:

javax.xml.soap.SOAPException - if there was a problem saving changes to this message.

setSaveRequired

public void setSaveRequired()

saveRequired

public boolean saveRequired()

Indicates whether this SOAPMessage object has had the method saveChanges() called on it.

Specified by:

saveRequired in class javax.xml.soap.SOAPMessage

Returns:

true if saveChanges has been called on this message at least once; false otherwise.

writeTo

public void writeTo(java.io.OutputStream out)
             throws javax.xml.soap.SOAPException,
                    java.io.IOException

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.

Specified by:

writeTo in class javax.xml.soap.SOAPMessage

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

setProperty

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 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.

Overrides:

setProperty in class javax.xml.soap.SOAPMessage

Parameters:

property - the property with which the specified value is to be associated

value - the value to be associated with the specified property

getProperty

public java.lang.Object getProperty(java.lang.String property)
                             throws javax.xml.soap.SOAPException

Retrieves value of the specified property.

Overrides:

getProperty in class javax.xml.soap.SOAPMessage

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

getAttachment

public javax.xml.soap.AttachmentPart getAttachment(javax.xml.soap.SOAPElement soapelement)
                                            throws javax.xml.soap.SOAPException

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 SOAP Messages with Attachments (http://www.w3.org/TR/SOAPattachments#SOAPReferenceToAttachements) , 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(ref:swaRef (http://www.wsi.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html") ). 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 (XOP (http://www.w3.org/2000/xp/Group/3/06/Attachments/XOP.html) ). other reference mechanisms may be supported by individual implementations of this standard. Contact your vendor for details.

Specified by:

getAttachment in class javax.xml.soap.SOAPMessage

Parameters:

element - - The SOAPElement containing the reference to an Attachment

Returns:

the referenced AttachmentPart or null if no such AttachmentPart exists or no reference can be found in this SOAPElement.

Throws:

javax.xml.soap.SOAPException - - if there is an error in the attempt to access the attachment

removeAttachments

public 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.

Specified by:

removeAttachments in class javax.xml.soap.SOAPMessage

Parameters:

headers - - a MimeHeaders object containing the MIME headers for which to search

Since:

SAAJ 1.3

getSOAPHeader

public javax.xml.soap.SOAPHeader getSOAPHeader()
                                        throws javax.xml.soap.SOAPException

Gets the SOAP Header contained in this SOAPMessage object.

Overrides:

getSOAPHeader in class javax.xml.soap.SOAPMessage

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

getSOAPBody

public javax.xml.soap.SOAPBody getSOAPBody()
                                    throws javax.xml.soap.SOAPException

Gets the SOAP Body contained in this SOAPMessage object.

Overrides:

getSOAPBody in class javax.xml.soap.SOAPMessage

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