org.jboss.axis.message
Class SOAPMessageImpl

java.lang.Object
  javax.xml.soap.SOAPMessage (src) 
      org.jboss.axis.message.SOAPMessageImpl

Direct Known Subclasses:

SOAPMessageAxisImpl (src)

public class SOAPMessageImpl

extends SOAPMessage (src)

An implemenation of the abstract SOAPMessage.

This class should not expose functionality that is not part of SOAPMessage (src) . Client code should use SOAPMessage whenever possible.

Since:

31-May-2004

mSOAPPart

protected SOAPPart (src)  mSOAPPart

mAttachments

protected Attachments (src)  mAttachments

headers

protected MimeHeadersImpl (src)  headers

SOAPMessageImpl

protected SOAPMessageImpl()

writeTo

public void writeTo(java.io.OutputStream os)
             throws SOAPException (src) ,
                    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 SOAPMessage (src)

Parameters:

os - the OutputStream object to which this SOAPMessage object will be written

Throws:

SOAPException (src) - if there was a problem in externalizing this SOAP message

java.io.IOException - if an I/O error occurs

getSOAPBody

public SOAPBody (src)  getSOAPBody()
                     throws SOAPException (src) 

Description copied from class: SOAPMessage (src)

Gets the SOAP Body contained in this SOAPMessage object.

Overrides:

getSOAPBody in class SOAPMessage (src)

Returns:

the SOAPBody object contained by this SOAPMessage object

Throws:

SOAPException (src) - if the SOAP Body does not exist or cannot be retrieved

getSOAPHeader

public SOAPHeader (src)  getSOAPHeader()
                         throws SOAPException (src) 

Description copied from class: SOAPMessage (src)

Gets the SOAP Header contained in this SOAPMessage object.

Overrides:

getSOAPHeader in class SOAPMessage (src)

Returns:

the SOAPHeader object contained by this SOAPMessage object

Throws:

SOAPException (src) - if the SOAP Header does not exist or cannot be retrieved

setProperty

public void setProperty(java.lang.String property,
                        java.lang.Object value)
                 throws SOAPException (src) 

Description copied from class: SOAPMessage (src)

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 SOAPMessage (src)

Parameters:

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

value - the value to be associated with the specified property

Throws:

SOAPException (src) - if the property name is not recognized

getProperty

public java.lang.Object getProperty(java.lang.String property)
                             throws SOAPException (src) 

Description copied from class: SOAPMessage (src)

Retrieves value of the specified property.

Overrides:

getProperty in class SOAPMessage (src)

Parameters:

property - the name of the property to retrieve

Returns:

the value associated with the named property or null if no such property exists.

Throws:

SOAPException (src) - if the property name is not recognized.

getContentDescription

public java.lang.String getContentDescription()

Retrieves a description of this SOAPMessage object's content.

Specified by:

getContentDescription in class SOAPMessage (src)

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 SOAPMessage (src)

Parameters:

description - a String describing the content of this message

See Also:

getContentDescription()

saveChanges

public void saveChanges()
                 throws SOAPException (src) 

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 SOAPMessage (src)

Throws:

SOAPException (src) - if there was a problem saving changes to this message.

saveRequired

public boolean saveRequired()

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

Specified by:

saveRequired in class SOAPMessage (src)

Returns:

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

getMimeHeaders

public MimeHeaders (src)  getMimeHeaders()

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

Specified by:

getMimeHeaders in class SOAPMessage (src)

Returns:

a MimeHeaders object containing the MimeHeader objects

getSOAPPart

public SOAPPart (src)  getSOAPPart()

Description copied from class: SOAPMessage (src)

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.

Specified by:

getSOAPPart in class SOAPMessage (src)

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 SOAPMessage (src)

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 SOAPMessage (src)

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 SOAPMessage (src)

Returns:

an iterator over all the attachments in this message

getAttachments

public java.util.Iterator getAttachments(MimeHeaders (src)  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 SOAPMessage (src)

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

addAttachmentPart

public void addAttachmentPart(AttachmentPart (src)  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 SOAPMessage (src)

Parameters:

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

Throws:

java.lang.IllegalArgumentException

createAttachmentPart

public AttachmentPart (src)  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 SOAPMessage (src)

Returns:

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