org.jboss.axis
Class Message

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

public class Message

extends SOAPMessageAxisImpl (src)

A complete SOAP (and/or XML-RPC, eventually) message. Includes both the root part (as a SOAPPart), and zero or more MIME attachments (as AttachmentParts).

Eventually should be refactored to generalize SOAPPart for multiple protocols (XML-RPC?).

REQUEST

public static final java.lang.String REQUEST

Message is a request.

See Also:

Constant Field Values (src)

RESPONSE

public static final java.lang.String RESPONSE

Message is a a response.

See Also:

Constant Field Values (src)

MIME_MULTIPART_RELATED

public static final java.lang.String MIME_MULTIPART_RELATED

MIME parts defined for messages.

See Also:

Constant Field Values (src)

MIME_APPLICATION_DIME

public static final java.lang.String MIME_APPLICATION_DIME

DIME parts defined for messages.

See Also:

Constant Field Values (src)

DEFAULT_ATTACHMNET_IMPL

public static final java.lang.String DEFAULT_ATTACHMNET_IMPL

Default Attachments Implementation class.

See Also:

Constant Field Values (src)

MIME_UNKNOWN

public static final java.lang.String MIME_UNKNOWN

Look at the input stream to find the headers to decide the mime type.

See Also:

Constant Field Values (src)

Message

public Message(java.lang.Object initialContents,
               boolean bodyInStream)

Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.

Eventually, genericize this to return the RootPart instead, which will have some kind of EnvelopeFactory to enable support for things other than SOAP. But that all will come later, with lots of additional refactoring.

Parameters:

initialContents - may be String, byte[], InputStream, SOAPEnvelope, or AxisFault.

bodyInStream - is true if initialContents is an InputStream containing just the SOAP body (no SOAP-ENV).

Message

public Message(java.lang.Object initialContents,
               boolean bodyInStream,
               MimeHeaders (src)  headers)

Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.

Eventually, genericize this to return the RootPart instead, which will have some kind of EnvelopeFactory to enable support for things other than SOAP. But that all will come later, with lots of additional refactoring.

Parameters:

initialContents - may be String, byte[], InputStream, SOAPEnvelope, or AxisFault.

bodyInStream - is true if initialContents is an InputStream containing just the SOAP body (no SOAP-ENV).

headers - Mime Headers.

Message

public Message(java.lang.Object initialContents,
               MimeHeadersImpl (src)  headers)

Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.

Eventually, genericize this to return the RootPart instead, which will have some kind of EnvelopeFactory to enable support for things other than SOAP. But that all will come later, with lots of additional refactoring.

Parameters:

initialContents - may be String, byte[], InputStream, SOAPEnvelope, or AxisFault.

headers - Mime Headers.

Message

public Message(java.lang.Object initialContents,
               boolean bodyInStream,
               java.lang.String contentType,
               java.lang.String contentLocation)

Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.

Eventually, genericize this to return the RootPart instead, which will have some kind of EnvelopeFactory to enable support for things other than SOAP. But that all will come later, with lots of additional refactoring.

Parameters:

initialContents - may be String, byte[], InputStream, SOAPEnvelope, or AxisFault

bodyInStream - is true if initialContents is an InputStream containing just the SOAP body (no SOAP-ENV)

contentType - this if the contentType has been already determined (as in the case of servlets)

contentLocation - the location of the content

Message

public Message(java.lang.Object initialContents)

Construct a Message. An overload of Message(Object, boolean), defaulting bodyInStream to false.

Parameters:

initialContents - may be String, byte[], InputStream, SOAPEnvelope, or AxisFault

getAttachmentImplClassName

public static java.lang.String getAttachmentImplClassName()

Returns the name of the class prividing Attachment Implementation.

Returns:

class name

getMessageType

public java.lang.String getMessageType()

Get the message type.

Returns:

the message type String

setMessageType

public void setMessageType(java.lang.String messageType)

Set the message type.

Parameters:

messageType - the message type String

getMessageContext

public MessageContext (src)  getMessageContext()

Get the context associated with this message.

Returns:

the message context for this message

setMessageContext

public void setMessageContext(MessageContext (src)  msgContext)

Set the context associated with this message.

Parameters:

msgContext - the message context for this message

getSOAPPart

public SOAPPart (src)  getSOAPPart()

Get this message's SOAPPart.

Eventually, this should be generalized beyond just SOAP, but it's hard to know how to do that without necessitating a lot of casts in client code. Refactoring keeps getting easier anyhow.

Overrides:

getSOAPPart in class SOAPMessageImpl (src)

Returns:

the soap part of this message

getSOAPPartAsString

public java.lang.String getSOAPPartAsString()
                                     throws AxisFault (src) 

Get a string representation of this message's SOAPPart.

Returns:

the soap part of this message as a String

Throws:

AxisFault (src) - if the stringification failed

getSOAPPartAsBytes

public byte[] getSOAPPartAsBytes()
                          throws AxisFault (src) 

Get a byte array representation of this message's SOAPPart.

Returns:

the soap part of this message as a byte[]

Throws:

AxisFault (src) - if creating the byte[] failed

getSOAPEnvelope

public SOAPEnvelopeAxisImpl (src)  getSOAPEnvelope()
                                     throws AxisFault (src) 

Get this message's SOAPPart as a SOAPEnvelope.

Returns:

a SOAPEnvelope containing this message's SOAPPart

Throws:

AxisFault (src) - if this failed

getAttachmentsImpl

public Attachments (src)  getAttachmentsImpl()

Get the Attachments of this Message.

If this returns null, then NO ATTACHMENT SUPPORT EXISTS in this configuration of Axis, and no attachment operations may be performed.

Returns:

the Attachments if attachments are supported, null otherwise

getContentType

public java.lang.String getContentType(SOAPConstants (src)  sc)
                                throws AxisFault (src) 

Get the content type of the attachments.

Parameters:

sc - provides the default content type

Returns:

a String giving the content type of the attachment

Throws:

AxisFault (src) - if there was an error deducing the content type from this message

getContentLength

public long getContentLength()
                      throws AxisFault (src) 

Get the content length, including both soap and any attachments.

Returns:

the total length of this message in bytes

Throws:

AxisFault (src) - if there was a problem that prevented the length being calculated

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.

Overrides:

writeTo in class SOAPMessageImpl (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 SOAPMessageImpl (src)

Throws:

SOAPException (src)

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

Throws:

SOAPException (src)

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

Throws:

SOAPException (src)

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

Throws:

SOAPException (src)

getContentDescription

public java.lang.String getContentDescription()

Retrieves a description of this SOAPMessage object's content.

Overrides:

getContentDescription in class SOAPMessageImpl (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.

Overrides:

setContentDescription in class SOAPMessageImpl (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.

Overrides:

saveChanges in class SOAPMessageImpl (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.

Overrides:

saveRequired in class SOAPMessageImpl (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.

Overrides:

getMimeHeaders in class SOAPMessageImpl (src)

Returns:

a MimeHeaders object containing the MimeHeader objects

removeAllAttachments

public void removeAllAttachments()

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

This method does not touch the SOAP part.

Overrides:

removeAllAttachments in class SOAPMessageImpl (src)

countAttachments

public int countAttachments()

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

Overrides:

countAttachments in class SOAPMessageImpl (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.

Overrides:

getAttachments in class SOAPMessageImpl (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.

Overrides:

getAttachments in class SOAPMessageImpl (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.

Overrides:

addAttachmentPart in class SOAPMessageImpl (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.

Overrides:

createAttachmentPart in class SOAPMessageImpl (src)

Returns:

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

dispose

public void dispose()

Dispose of attachments.