|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.xml.soap.SOAPMessage
org.apache.axis2.saaj.SOAPMessageImpl
public class SOAPMessageImpl
Field Summary |
---|
Fields inherited from class javax.xml.soap.SOAPMessage |
---|
CHARACTER_SET_ENCODING, WRITE_XML_DECLARATION |
Constructor Summary | |
---|---|
SOAPMessageImpl(InputStream inputstream,
MimeHeaders mimeHeaders)
|
|
SOAPMessageImpl(SOAPEnvelopeImpl soapEnvelope)
|
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. |
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. |
String |
getContentDescription()
Retrieves a description of this SOAPMessage
object's content. |
MimeHeaders |
getMimeHeaders()
Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent
fashion. |
Object |
getProperty(String property)
Retrieves value of the specified property. |
SOAPBody |
getSOAPBody()
Gets the SOAP Body contained in this SOAPMessage object. |
SOAPHeader |
getSOAPHeader()
Gets the SOAP Header contained in this SOAPMessage object. |
SOAPPart |
getSOAPPart()
Gets the SOAP part of this SOAPMessage object. |
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 |
setProperty(String property,
Object value)
Associates the specified value with the specified property. |
void |
setSaveRequired()
|
void |
writeTo(OutputStream out)
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 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SOAPMessageImpl(SOAPEnvelopeImpl soapEnvelope)
public SOAPMessageImpl(InputStream inputstream, MimeHeaders mimeHeaders) throws SOAPException
SOAPException
Method Detail |
---|
public 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(String description)
SOAPMessage
object's content with the given description.
setContentDescription
in class SOAPMessage
description
- a String
describing the content of this messagegetContentDescription()
public SOAPPart getSOAPPart()
SOAPMessage
object.
If a SOAPMessage
object contains one or
more attachments, the SOAP Part must be the first MIME body
part in the message.
getSOAPPart
in class SOAPMessage
SOAPPart
object for this
SOAPMessage
objectpublic 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 Iterator getAttachments()
AttachmentPart
objects
that are part of this SOAPMessage
object.
getAttachments
in class SOAPMessage
public Iterator getAttachments(MimeHeaders headers)
getAttachments
in class SOAPMessage
headers
- a MimeHeaders
object containing the MIME headers for which to search
AttachmentPart
)
that have a header that matches one of the given headerspublic 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
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 MimeHeaders getMimeHeaders()
SOAPMessage
object in a transport-independent
fashion.
getMimeHeaders
in class SOAPMessage
MimeHeaders
object containing the
MimeHeader
objectspublic 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 void setSaveRequired()
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 void writeTo(OutputStream out) throws SOAPException, 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
out
- the OutputStream
object to which this SOAPMessage
object will
be written
SOAPException
- if there was a problem in externalizing this SOAP message
IOException
- if an I/O error occurspublic void setProperty(String property, Object value)
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 propertypublic Object getProperty(String property) throws SOAPException
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 SOAPHeader getSOAPHeader() throws SOAPException
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 SOAPBody getSOAPBody() throws SOAPException
SOAPMessage
object.
getSOAPBody
in class SOAPMessage
SOAPBody
object contained by this
SOAPMessage
object
SOAPException
- if the SOAP Body does not exist or cannot be
retrieved
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |