|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.xml.soap.SOAPMessage org.apache.axis.Message
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?).
Field Summary | |
static java.lang.String |
DEFAULT_ATTACHMNET_IMPL
Default Attachments Implementation class. |
static java.lang.String |
MIME_APPLICATION_DIME
DIME parts defined for messages. |
static java.lang.String |
MIME_MULTIPART_RELATED
MIME parts defined for messages. |
static java.lang.String |
MIME_UNKNOWN
Look at the input stream to find the headers to decide the mime type. |
static java.lang.String |
REQUEST
Message is a request. |
static java.lang.String |
RESPONSE
Message is a a response. |
Fields inherited from class javax.xml.soap.SOAPMessage |
CHARACTER_SET_ENCODING, WRITE_XML_DECLARATION |
Constructor Summary | |
Message(java.lang.Object initialContents)
Construct a Message. |
|
Message(java.lang.Object initialContents,
boolean bodyInStream)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart. |
|
Message(java.lang.Object initialContents,
boolean bodyInStream,
MimeHeaders headers)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart. |
|
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. |
|
Message(java.lang.Object initialContents,
MimeHeaders headers)
Construct a Message, using the provided initialContents as the contents of the Message's SOAPPart. |
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 java.lang.String |
getAttachmentImplClassName()
Returns the name of the class prividing Attachment Implementation. |
java.util.Iterator |
getAttachments()
Retrieves all the AttachmentPart objects
that are part of this SOAPMessage object. |
java.util.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. |
java.lang.String |
getContentDescription()
Retrieves a description of this SOAPMessage
object's content. |
long |
getContentLength()
Get the content length, including both soap and any attachments. |
java.lang.String |
getContentType(SOAPConstants sc)
Get the content type of the attachments. |
MessageContext |
getMessageContext()
Get the context associated with this message. |
java.lang.String |
getMessageType()
Get the message type. |
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. |
SOAPBody |
getSOAPBody()
Gets the SOAP Body contained in this SOAPMessage object. |
SOAPEnvelope |
getSOAPEnvelope()
Get this message's SOAPPart as a SOAPEnvelope. |
SOAPHeader |
getSOAPHeader()
Gets the SOAP Header contained in this SOAPMessage object. |
SOAPPart |
getSOAPPart()
Get this message's SOAPPart. |
byte[] |
getSOAPPartAsBytes()
Get a byte array representation of this message's SOAPPart. |
java.lang.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(java.lang.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(java.lang.String messageType)
Set the message type. |
void |
setProperty(java.lang.String property,
java.lang.Object value)
Associates the specified value with the specified property. |
void |
writeTo(java.io.OutputStream os)
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 |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String REQUEST
public static final java.lang.String RESPONSE
public static final java.lang.String MIME_MULTIPART_RELATED
public static final java.lang.String MIME_APPLICATION_DIME
public static final java.lang.String DEFAULT_ATTACHMNET_IMPL
public static final java.lang.String MIME_UNKNOWN
Constructor Detail |
public Message(java.lang.Object initialContents, boolean bodyInStream)
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.
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).public Message(java.lang.Object initialContents, boolean bodyInStream, MimeHeaders 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.
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.public Message(java.lang.Object initialContents, MimeHeaders 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.
initialContents
- may be String, byte[], InputStream, SOAPEnvelope,
or AxisFault.headers
- Mime Headers.public Message(java.lang.Object initialContents, boolean bodyInStream, java.lang.String contentType, java.lang.String contentLocation)
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.
initialContents
- may be String, byte[], InputStream, SOAPEnvelope,
or AxisFaultbodyInStream
- 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 contentpublic Message(java.lang.Object initialContents)
initialContents
- may be String, byte[], InputStream, SOAPEnvelope,
or AxisFaultMethod Detail |
public static java.lang.String getAttachmentImplClassName()
public java.lang.String getMessageType()
String
public void setMessageType(java.lang.String messageType)
messageType
- the message type String
public MessageContext getMessageContext()
public void setMessageContext(MessageContext msgContext)
msgContext
- the message context for this messagepublic SOAPPart getSOAPPart()
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.
getSOAPPart
in class SOAPMessage
public java.lang.String getSOAPPartAsString() throws AxisFault
String
AxisFault
- if the stringification failedpublic byte[] getSOAPPartAsBytes() throws AxisFault
byte[]
AxisFault
- if creating the byte[] failedpublic SOAPEnvelope getSOAPEnvelope() throws AxisFault
AxisFault
- if this failedpublic Attachments getAttachmentsImpl()
If this returns null, then NO ATTACHMENT SUPPORT EXISTS in this configuration of Axis, and no attachment operations may be performed.
Attachments
if attachments are supported, null
otherwisepublic java.lang.String getContentType(SOAPConstants sc) throws AxisFault
sc
- provides the default content type
String
giving the content type of the
attachment
AxisFault
- if there was an error deducing the content type from
this messagepublic long getContentLength() throws AxisFault
AxisFault
- if there was a problem that prevented
the length being calculatedpublic void writeTo(java.io.OutputStream os) throws SOAPException, java.io.IOException
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.
writeTo
in class SOAPMessage
os
- the OutputStream
object to which this SOAPMessage
object will
be written
SOAPException
- if there was a problem in
externalizing this SOAP message
java.io.IOException
- if an I/O error
occurspublic SOAPBody getSOAPBody() throws SOAPException
SOAPMessage
SOAPMessage
object.
getSOAPBody
in class SOAPMessage
SOAPBody
object contained by this
SOAPMessage
object
SOAPException
- if the SOAP Body does not exist or cannot be
retrievedpublic SOAPHeader getSOAPHeader() throws SOAPException
SOAPMessage
SOAPMessage
object.
getSOAPHeader
in class SOAPMessage
SOAPHeader
object contained by this
SOAPMessage
object
SOAPException
- if the SOAP Header does not exist or cannot be
retrievedpublic void setProperty(java.lang.String property, java.lang.Object value) throws SOAPException
SOAPMessage
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.
setProperty
in class SOAPMessage
property
- the property with which the specified value is to be
associatedvalue
- the value to be associated with the specified property
SOAPException
- if the property name is not recognizedpublic java.lang.Object getProperty(java.lang.String property) throws SOAPException
SOAPMessage
getProperty
in class SOAPMessage
property
- the name of the property to retrieve
null
if no such
property exists
SOAPException
- if the property name is not recognizedpublic java.lang.String getContentDescription()
SOAPMessage
object's content.
getContentDescription
in class SOAPMessage
String
describing the content of this
message or null
if no description has been
setsetContentDescription(java.lang.String)
public void setContentDescription(java.lang.String description)
SOAPMessage
object's content with the given description.
setContentDescription
in class SOAPMessage
description
- a String
describing the content of this messagegetContentDescription()
public void saveChanges() throws SOAPException
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.
saveChanges
in class SOAPMessage
SOAPException
- if there
was a problem saving changes to this message.public boolean saveRequired()
SOAPMessage
object
has had the method saveChanges
called on
it.
saveRequired
in class SOAPMessage
true
if saveChanges
has
been called on this message at least once;
false
otherwise.public MimeHeaders getMimeHeaders()
SOAPMessage
object in a transport-independent
fashion.
getMimeHeaders
in class SOAPMessage
MimeHeaders
object containing the
MimeHeader
objectspublic void removeAllAttachments()
AttachmentPart
objects that have
been added to this SOAPMessage
object.
This method does not touch the SOAP part.
removeAllAttachments
in class SOAPMessage
public int countAttachments()
countAttachments
in class SOAPMessage
AttachmentPart
objects
that are part of this SOAPMessage
objectpublic java.util.Iterator getAttachments()
AttachmentPart
objects
that are part of this SOAPMessage
object.
getAttachments
in class SOAPMessage
public java.util.Iterator getAttachments(MimeHeaders headers)
AttachmentPart
objects
that have header entries that match the specified headers.
Note that a returned attachment could have headers in
addition to those specified.
getAttachments
in class SOAPMessage
headers
- a MimeHeaders
object containing the MIME headers for which to
search
public void addAttachmentPart(AttachmentPart attachmentpart)
AttachmentPart
object to this
SOAPMessage
object. An
AttachmentPart
object must be created before it can be
added to a message.
addAttachmentPart
in class SOAPMessage
attachmentpart
- an
AttachmentPart
object that is to become part of
this SOAPMessage
object
java.lang.IllegalArgumentException
public AttachmentPart createAttachmentPart()
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.
createAttachmentPart
in class SOAPMessage
AttachmentPart
object that can be
populated and added to this SOAPMessage
objectpublic void dispose()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |