org.apache.axis
public class Message extends SOAPMessage implements Serializable
Eventually should be refactored to generalize SOAPPart for multiple protocols (XML-RPC?).
Field Summary | |
---|---|
static String | DEFAULT_ATTACHMNET_IMPL Default Attachments Implementation class. |
protected static Log | log
The Log that this class uses for logging all messages. |
static String | MIME_APPLICATION_DIME DIME parts defined for messages. |
static String | MIME_MULTIPART_RELATED MIME parts defined for messages. |
static String | MIME_UNKNOWN Look at the input stream to find the headers to decide the mime type. |
static String | REQUEST Message is a request. |
static String | RESPONSE 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 | |
---|---|
void | addAttachmentPart(AttachmentPart attachmentpart)
Adds the given AttachmentPart object to this
SOAPMessage object. |
int | countAttachments()
Gets a count of the number of attachments in this
message. |
AttachmentPart | createAttachmentPart()
Creates a new empty AttachmentPart object.
|
void | dispose()
Dispose of attachments. |
static String | getAttachmentImplClassName()
Returns the name of the class prividing Attachment Implementation.
|
Iterator | getAttachments()
Retrieves all the AttachmentPart objects
that are part of this SOAPMessage object. |
Iterator | getAttachments(MimeHeaders headers)
Retrieves all the AttachmentPart objects
that have header entries that match the specified headers.
|
Attachments | getAttachmentsImpl()
Get the Attachments of this Message.
|
String | getContentDescription()
Retrieves a description of this SOAPMessage
object's content. |
long | getContentLength()
Get the content length, including both soap and any attachments.
|
String | getContentType(SOAPConstants sc)
Get the content type of the attachments.
|
MessageContext | getMessageContext()
Get the context associated with this message.
|
String | getMessageType()
Get the message type.
|
MimeHeaders | getMimeHeaders()
Returns all the transport-specific MIME headers for this
SOAPMessage object in a transport-independent
fashion. |
Object | getProperty(String property) |
SOAPBody | getSOAPBody() |
SOAPEnvelope | getSOAPEnvelope()
Get this message's SOAPPart as a SOAPEnvelope.
|
SOAPHeader | getSOAPHeader() |
SOAPPart | getSOAPPart()
Get this message's SOAPPart.
|
byte[] | getSOAPPartAsBytes()
Get a byte array representation of this message's SOAPPart.
|
String | getSOAPPartAsString()
Get a string representation of this message's SOAPPart.
|
void | removeAllAttachments()
Removes all AttachmentPart objects that have
been added to this SOAPMessage object.
|
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(String description)
Sets the description of this SOAPMessage
object's content with the given description. |
void | setMessageContext(MessageContext msgContext)
Set the context associated with this message.
|
void | setMessageType(String messageType)
Set the message type.
|
void | setProperty(String property, Object value) |
void | writeTo(OutputStream os)
Writes this SOAPMessage object to the given
output stream. |
Log
that this class uses for logging all messages.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).
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.
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.
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
Parameters: initialContents may be String, byte[], InputStream, SOAPEnvelope, or AxisFault
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
Returns: the number of AttachmentPart
objects
that are part of this SOAPMessage
object
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
Returns: class name
AttachmentPart
objects
that are part of this SOAPMessage
object.Returns: an iterator over all the attachments in this message
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
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
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)
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
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
Returns: the message context for this message
Returns: the message type String
SOAPMessage
object in a transport-independent
fashion.Returns: a MimeHeaders
object containing the
MimeHeader
objects
Returns: a SOAPEnvelope containing this message's SOAPPart
Throws: AxisFault if this failed
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
Returns: the soap part of this message as a byte[]
Throws: org.apache.axis.AxisFault if creating the byte[] failed
Returns: the soap part of this message as a String
Throws: org.apache.axis.AxisFault if the stringification failed
AttachmentPart
objects that have
been added to this SOAPMessage
object.
This method does not touch the SOAP part.
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.
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.
SOAPMessage
object's content with the given description.Parameters: description a String
describing the content of this message
See Also: getContentDescription()
Parameters: msgContext the message context for this message
Parameters: messageType the message type String
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