org.apache.axis

Class Message

public class Message extends SOAPMessage implements Serializable

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

Author: Rob Jellinghaus (robj@unrealities.com) Doug Davis (dug@us.ibm.com) Glen Daniels (gdaniels@allaire.com) Rick Rineholt Heejune Ahn (cityboy@tmax.co.kr)

Field Summary
static StringDEFAULT_ATTACHMNET_IMPL
Default Attachments Implementation class.
protected static Loglog
The Log that this class uses for logging all messages.
static StringMIME_APPLICATION_DIME
DIME parts defined for messages.
static StringMIME_MULTIPART_RELATED
MIME parts defined for messages.
static StringMIME_UNKNOWN
Look at the input stream to find the headers to decide the mime type.
static StringREQUEST
Message is a request.
static StringRESPONSE
Message is a a response.
Constructor Summary
Message(Object initialContents, boolean bodyInStream)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.
Message(Object initialContents, boolean bodyInStream, MimeHeaders headers)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.
Message(Object initialContents, MimeHeaders headers)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.
Message(Object initialContents, boolean bodyInStream, String contentType, String contentLocation)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart.
Message(Object initialContents)
Construct a Message.
Method Summary
voidaddAttachmentPart(AttachmentPart attachmentpart)
Adds the given AttachmentPart object to this SOAPMessage object.
intcountAttachments()
Gets a count of the number of attachments in this message.
AttachmentPartcreateAttachmentPart()
Creates a new empty AttachmentPart object.
voiddispose()
Dispose of attachments.
static StringgetAttachmentImplClassName()
Returns the name of the class prividing Attachment Implementation.
IteratorgetAttachments()
Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.
IteratorgetAttachments(MimeHeaders headers)
Retrieves all the AttachmentPart objects that have header entries that match the specified headers.
AttachmentsgetAttachmentsImpl()
Get the Attachments of this Message.
StringgetContentDescription()
Retrieves a description of this SOAPMessage object's content.
longgetContentLength()
Get the content length, including both soap and any attachments.
StringgetContentType(SOAPConstants sc)
Get the content type of the attachments.
MessageContextgetMessageContext()
Get the context associated with this message.
StringgetMessageType()
Get the message type.
MimeHeadersgetMimeHeaders()
Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.
ObjectgetProperty(String property)
SOAPBodygetSOAPBody()
SOAPEnvelopegetSOAPEnvelope()
Get this message's SOAPPart as a SOAPEnvelope.
SOAPHeadergetSOAPHeader()
SOAPPartgetSOAPPart()
Get this message's SOAPPart.
byte[]getSOAPPartAsBytes()
Get a byte array representation of this message's SOAPPart.
StringgetSOAPPartAsString()
Get a string representation of this message's SOAPPart.
voidremoveAllAttachments()
Removes all AttachmentPart objects that have been added to this SOAPMessage object.
voidsaveChanges()
Updates this SOAPMessage object with all the changes that have been made to it.
booleansaveRequired()
Indicates whether this SOAPMessage object has had the method saveChanges called on it.
voidsetContentDescription(String description)
Sets the description of this SOAPMessage object's content with the given description.
voidsetMessageContext(MessageContext msgContext)
Set the context associated with this message.
voidsetMessageType(String messageType)
Set the message type.
voidsetProperty(String property, Object value)
voidwriteTo(OutputStream os)
Writes this SOAPMessage object to the given output stream.

Field Detail

DEFAULT_ATTACHMNET_IMPL

public static final String DEFAULT_ATTACHMNET_IMPL
Default Attachments Implementation class.

log

protected static Log log
The Log that this class uses for logging all messages.

MIME_APPLICATION_DIME

public static final String MIME_APPLICATION_DIME
DIME parts defined for messages.

MIME_MULTIPART_RELATED

public static final String MIME_MULTIPART_RELATED
MIME parts defined for messages.

MIME_UNKNOWN

public static final String MIME_UNKNOWN
Look at the input stream to find the headers to decide the mime type.

REQUEST

public static final String REQUEST
Message is a request.

RESPONSE

public static final String RESPONSE
Message is a a response.

Constructor Detail

Message

public Message(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(Object initialContents, boolean bodyInStream, MimeHeaders 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(Object initialContents, MimeHeaders 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(Object initialContents, boolean bodyInStream, String contentType, 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(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

Method Detail

addAttachmentPart

public void addAttachmentPart(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.

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

Throws: java.lang.IllegalArgumentException

countAttachments

public int countAttachments()
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

createAttachmentPart

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

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

dispose

public void dispose()
Dispose of attachments.

getAttachmentImplClassName

public static String getAttachmentImplClassName()
Returns the name of the class prividing Attachment Implementation.

Returns: class name

getAttachments

public Iterator getAttachments()
Retrieves all the AttachmentPart objects that are part of this SOAPMessage object.

Returns: an iterator over all the attachments in this message

getAttachments

public Iterator getAttachments(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.

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

getAttachmentsImpl

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

getContentDescription

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

getContentLength

public long getContentLength()
Get the content length, including both soap and any attachments.

Returns: the total length of this message in bytes

Throws: org.apache.axis.AxisFault if there was a problem that prevented the length being calculated

getContentType

public String getContentType(SOAPConstants sc)
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 if there was an error deducing the content type from this message

getMessageContext

public MessageContext getMessageContext()
Get the context associated with this message.

Returns: the message context for this message

getMessageType

public String getMessageType()
Get the message type.

Returns: the message type String

getMimeHeaders

public MimeHeaders getMimeHeaders()
Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.

Returns: a MimeHeaders object containing the MimeHeader objects

getProperty

public Object getProperty(String property)

getSOAPBody

public SOAPBody getSOAPBody()

getSOAPEnvelope

public SOAPEnvelope getSOAPEnvelope()
Get this message's SOAPPart as a SOAPEnvelope.

Returns: a SOAPEnvelope containing this message's SOAPPart

Throws: AxisFault if this failed

getSOAPHeader

public SOAPHeader getSOAPHeader()

getSOAPPart

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

Returns: the soap part of this message

getSOAPPartAsBytes

public byte[] getSOAPPartAsBytes()
Get a byte array representation of this message's SOAPPart.

Returns: the soap part of this message as a byte[]

Throws: org.apache.axis.AxisFault if creating the byte[] failed

getSOAPPartAsString

public String getSOAPPartAsString()
Get a string representation of this message's SOAPPart.

Returns: the soap part of this message as a String

Throws: org.apache.axis.AxisFault if the stringification failed

removeAllAttachments

public void removeAllAttachments()
Removes all AttachmentPart objects that have been added to this SOAPMessage object.

This method does not touch the SOAP part.

saveChanges

public void saveChanges()
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: SOAPException 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.

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

setContentDescription

public void setContentDescription(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()

setMessageContext

public void setMessageContext(MessageContext msgContext)
Set the context associated with this message.

Parameters: msgContext the message context for this message

setMessageType

public void setMessageType(String messageType)
Set the message type.

Parameters: messageType the message type String

setProperty

public void setProperty(String property, Object value)

writeTo

public void writeTo(OutputStream os)
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: os the OutputStream object to which this SOAPMessage object will be written

Throws: SOAPException if there was a problem in externalizing this SOAP message IOException if an I/O error occurs

Copyright B) 2005 Apache Web Services Project. All Rights Reserved.