|
Novell exteNd Web Services SDK API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.xml.soap.SOAPMessage
The root class for all SOAP messages. As transmitted on the "wire", a SOAP message is an XML document or a MIME message whose first body part is an XML/SOAP document.
A SOAPMessage
object consists of a SOAP part and
optionally one or more attachment parts. The SOAP part for a
SOAPMessage
object is a
SOAPPart
object, which contains information
used for message routing and identification, and which can contain
application-specific content. All data in the SOAP Part of a message must
be in XML format.
A new SOAPMessage
object contains the following by default:
SOAPPart
object
SOAPEnvelope
object
SOAPBody
object
SOAPHeader
object
SOAPMessage.getSOAPPart()
. The SOAPEnvelope
object is retrieved from the SOAPPart
object, and the
SOAPEnvelope
object is used to retrieve the
SOAPBody
and SOAPHeader
objects.
SOAPPart sp = message.getSOAPPart(); SOAPEnvelope se = sp.getEnvelope(); SOAPBody sb = se.getBody(); SOAPHeader sh = se.getHeader();
In addition to the mandatory SOAPPart
object,
a SOAPMessage
object may contain
zero or more AttachmentPart
objects, each of which
contains application-specific data. The
SOAPMessage
interface provides methods for creating
AttachmentPart
objects and also for adding them to a
SOAPMessage
object. A party that has received a
SOAPMessage
object can examine its contents by retrieving
individual attachment parts.
Unlike the rest of a SOAP message, an attachment is not required to be
in XML format and can therefore be anything from simple text to an
image file. Consequently, any message content that is not in XML format must
be in an AttachmentPart
object.
A MessageFactory
object creates new SOAPMessage
objects. If the MessageFactory
object was initialized with
a messaging Profile, it produces SOAPMessage
objects that
conform to that Profile. For example, a SOAPMessage
object
created by a MessageFactory
object initialized with the
ebXML Profile will have the appropriate ebXML headers.
MessageFactory
,
AttachmentPart
Field Summary | |
static String |
CHARACTER_SET_ENCODING
Specifies the character type encoding for the SOAP Message. |
static String |
WRITE_XML_DECLARATION
Specifies whether the SOAP Message should contain an XML declaration. |
Constructor Summary | |
SOAPMessage()
|
Method Summary | |
abstract void |
addAttachmentPart(AttachmentPart AttachmentPart)
Adds the given AttachmentPart object to this
SOAPMessage object. |
abstract int |
countAttachments()
Gets a count of the number of attachments in this message. |
abstract AttachmentPart |
createAttachmentPart()
Creates a new empty AttachmentPart object. |
AttachmentPart |
createAttachmentPart(DataHandler dataHandler)
Creates an AttachmentPart object
and populates it using the given DataHandler object. |
AttachmentPart |
createAttachmentPart(Object content,
String contentType)
Creates an AttachmentPart object
and populates it with the specified data of the specified
content type. |
abstract Iterator |
getAttachments()
Retrieves all the AttachmentPart objects that are part
of this SOAPMessage object. |
abstract Iterator |
getAttachments(MimeHeaders headers)
Retrieves all the AttachmentPart objects that have
header entries that match the specified headers. |
abstract String |
getContentDescription()
Retrieves a description of this SOAPMessage object's
content. |
abstract MimeHeaders |
getMimeHeaders()
Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion. |
abstract Object |
getProperty(String property)
Retrieves value of the specified property. |
abstract SOAPBody |
getSOAPBody()
Gets the SOAP Body contained in this SOAPMessage object. |
abstract SOAPHeader |
getSOAPHeader()
Gets the SOAP Header contained in this SOAPMessage object. |
abstract SOAPPart |
getSOAPPart()
Gets the SOAP part of this SOAPMessage object. |
abstract void |
removeAllAttachments()
Removes all AttachmentPart objects that have been added
to this SOAPMessage object. |
abstract void |
saveChanges()
Updates this SOAPMessage object with all the
changes that have been made to it. |
abstract boolean |
saveRequired()
Indicates whether this SOAPMessage object needs to have
the method saveChanges called on it. |
abstract void |
setContentDescription(String description)
Sets the description of this SOAPMessage object's
content with the given description. |
abstract void |
setProperty(String property,
Object value)
Associates the specified value with the specified property. |
abstract void |
writeTo(OutputStream out)
Writes this SOAPMessage object to the given output
stream. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String CHARACTER_SET_ENCODING
SOAPMessage.setProperty
,
Constant Field Valuespublic static final String WRITE_XML_DECLARATION
SOAPMessage.setProperty
,
Constant Field ValuesConstructor Detail |
public SOAPMessage()
Method Detail |
public abstract void setContentDescription(String description)
SOAPMessage
object's
content with the given description.
description
- a String
describing the content of this
messagegetContentDescription()
public abstract String getContentDescription()
SOAPMessage
object's
content.
String
describing the content of this
message or null
if no description has been setsetContentDescription(java.lang.String)
public abstract 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.
SOAPPart
object for this
SOAPMessage
objectpublic abstract SOAPBody getSOAPBody() throws SOAPException
SOAPMessage
object.
SOAPBody
object contained by this
SOAPMessage
object
SOAPException
- if the SOAP Body does not exist or cannot be retrievedpublic abstract SOAPHeader getSOAPHeader() throws SOAPException
SOAPMessage
object.
SOAPHeader
object contained by this
SOAPMessage
object
SOAPException
- if the SOAP Header does not exist or cannot be retrievedpublic abstract void removeAllAttachments()
AttachmentPart
objects that have been added
to this SOAPMessage
object.
This method does not touch the SOAP part.
public abstract int countAttachments()
AttachmentPart
objects that are
part of this SOAPMessage
objectpublic abstract Iterator getAttachments()
AttachmentPart
objects that are part
of this SOAPMessage
object.
public abstract 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.
headers
- a MimeHeaders
object containing the
MIME headers for which to search
public abstract void addAttachmentPart(AttachmentPart AttachmentPart)
AttachmentPart
object to this
SOAPMessage
object. An AttachmentPart
object must be created before it can be added to a message.
AttachmentPart
- an AttachmentPart
object
that is to become part of this
SOAPMessage
object
IllegalArgumentException
public abstract 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.
AttachmentPart
object that can be
populated and added to this SOAPMessage
objectpublic AttachmentPart createAttachmentPart(DataHandler dataHandler)
AttachmentPart
object
and populates it using the given DataHandler
object.
dataHandler
- the javax.activation.DataHandler
object that will generate the content for this
SOAPMessage
object
AttachmentPart
object that contains
data generated by the given DataHandler
object
IllegalArgumentException
- if there was a problem with
the specified DataHandler
objectDataHandler
,
DataContentHandler
public abstract MimeHeaders getMimeHeaders()
SOAPMessage
object in a transport-independent fashion.
MimeHeaders
object containing the
MimeHeader
objectspublic AttachmentPart createAttachmentPart(Object content, String contentType)
AttachmentPart
object
and populates it with the specified data of the specified
content type.
content
- an Object
containing the content for this
SOAPMessage
objectcontentType
- a String
object giving the type of
content; examples are "text/xml", "text/plain", and "image/jpeg"
AttachmentPart
object that contains the
given data
IllegalArgumentException
- if the contentType does not
match the type of the content object, or if there
was no DataContentHandler
object for the given
content objectDataHandler
,
DataContentHandler
public abstract void saveChanges() throws SOAPException
SOAPMessage
object with all the
changes that have been made to it. This method is
called automatically when writeTo(OutputStream)
is
called. 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.
SOAPException
- if there was a problem
saving changes to this message.
SOAPException
public abstract boolean saveRequired()
SOAPMessage
object needs to have
the method saveChanges
called on it.
true
if saveChanges
needs to be called;
false
otherwise.public abstract 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.
out
- the OutputStream
object to which this
SOAPMessage
object will be written
IOException
- if an I/O error occurs
SOAPException
- if there was a problem in
externalizing this SOAP messagepublic abstract void setProperty(String property, Object value) throws SOAPException
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.
property
- the property with which the specified value is to be associated.value
- the value to be associated with the specified property
SOAPException
- if the property name is not recognized.public abstract Object getProperty(String property) throws SOAPException
property
- the name of the property to retrieve
null
if no such property exists.
SOAPException
- if the property name is not recognized.
|
Novell exteNd Web Services SDK API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |