Google Git
Sign in
apache / axis-site / f545f87a6b723b56329b1ebb949e3b91067c8436 / . / axis / java / apiDocs / javax / xml / soap / SOAPMessage.html
blob: da529da13dfb6d2214affcfceaa8fa731b16cb50 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SOAPMessage (Apache Axis)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SOAPMessage (Apache Axis)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SOAPMessage.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../javax/xml/soap/SOAPHeaderElement.html" title="interface in javax.xml.soap"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/soap/SOAPMessage.html" target="_top">Frames</a></li>
<li><a href="SOAPMessage.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">javax.xml.soap</div>
<h2 title="Class SOAPMessage" class="title">Class SOAPMessage</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>javax.xml.soap.SOAPMessage</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../org/apache/axis/Message.html" title="class in org.apache.axis">Message</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">SOAPMessage</span>
extends <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><P>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.</P>
<P>A <CODE>SOAPMessage</CODE> object consists of a SOAP part
and optionally one or more attachment parts. The SOAP part for
a <CODE>SOAPMessage</CODE> object is a <CODE>SOAPPart</CODE>
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.</P>
<P>A new <CODE>SOAPMessage</CODE> object contains the following
by default:</P>
<UL>
<LI>A <CODE>SOAPPart</CODE> object</LI>
<LI>A <CODE>SOAPEnvelope</CODE> object</LI>
<LI>A <CODE>SOAPBody</CODE> object</LI>
<LI>A <CODE>SOAPHeader</CODE> object</LI>
</UL>
The SOAP part of a message can be retrieved by calling the
method <CODE>SOAPMessage.getSOAPPart()</CODE>. The <CODE>
SOAPEnvelope</CODE> object is retrieved from the <CODE>
SOAPPart</CODE> object, and the <CODE>SOAPEnvelope</CODE>
object is used to retrieve the <CODE>SOAPBody</CODE> and <CODE>
SOAPHeader</CODE> objects.
<PRE>
SOAPPart sp = message.getSOAPPart();
SOAPEnvelope se = sp.getEnvelope();
SOAPBody sb = se.getBody();
SOAPHeader sh = se.getHeader();
</PRE>
<P>In addition to the mandatory <CODE>SOAPPart</CODE> object, a
<CODE>SOAPMessage</CODE> object may contain zero or more <CODE>
AttachmentPart</CODE> objects, each of which contains
application-specific data. The <CODE>SOAPMessage</CODE>
interface provides methods for creating <CODE>
AttachmentPart</CODE> objects and also for adding them to a
<CODE>SOAPMessage</CODE> object. A party that has received a
<CODE>SOAPMessage</CODE> object can examine its contents by
retrieving individual attachment parts.</P>
<P>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 <CODE>
AttachmentPart</CODE> object.</P>
<P>A <CODE>MessageFactory</CODE> object creates new <CODE>
SOAPMessage</CODE> objects. If the <CODE>MessageFactory</CODE>
object was initialized with a messaging Profile, it produces
<CODE>SOAPMessage</CODE> objects that conform to that Profile.
For example, a <CODE>SOAPMessage</CODE> object created by a
<CODE>MessageFactory</CODE> object initialized with the ebXML
Profile will have the appropriate ebXML headers.</P></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/xml/soap/MessageFactory.html" title="class in javax.xml.soap"><code>MessageFactory</code></a>,
<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap"><code>AttachmentPart</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#CHARACTER_SET_ENCODING">CHARACTER_SET_ENCODING</a></strong></code>
<div class="block">Specifies the character type encoding for the SOAP Message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#WRITE_XML_DECLARATION">WRITE_XML_DECLARATION</a></strong></code>
<div class="block">Specifies whether the SOAP Message should contain an XML declaration.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#SOAPMessage()">SOAPMessage</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#addAttachmentPart(javax.xml.soap.AttachmentPart)">addAttachmentPart</a></strong>(<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a>&nbsp;attachmentpart)</code>
<div class="block">Adds the given <CODE>AttachmentPart</CODE> object to this
<CODE>SOAPMessage</CODE> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#countAttachments()">countAttachments</a></strong>()</code>
<div class="block">Gets a count of the number of attachments in this
message.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart()">createAttachmentPart</a></strong>()</code>
<div class="block">Creates a new empty <CODE>AttachmentPart</CODE> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart(javax.activation.DataHandler)">createAttachmentPart</a></strong>(<a href="http://download.oracle.com/javaee/1.4/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation">DataHandler</a>&nbsp;datahandler)</code>
<div class="block">Creates an <CODE>AttachmentPart</CODE> object and
populates it using the given <CODE>DataHandler</CODE>
object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#createAttachmentPart(java.lang.Object,%20java.lang.String)">createAttachmentPart</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;content,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;contentType)</code>
<div class="block">Creates an <CODE>AttachmentPart</CODE> object and
populates it with the specified data of the specified content
type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#getAttachments()">getAttachments</a></strong>()</code>
<div class="block">Retrieves all the <CODE>AttachmentPart</CODE> objects
that are part of this <CODE>SOAPMessage</CODE> object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#getAttachments(javax.xml.soap.MimeHeaders)">getAttachments</a></strong>(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a>&nbsp;headers)</code>
<div class="block">Retrieves all the <CODE>AttachmentPart</CODE> objects
that have header entries that match the specified headers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#getContentDescription()">getContentDescription</a></strong>()</code>
<div class="block">Retrieves a description of this <CODE>SOAPMessage</CODE>
object's content.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#getMimeHeaders()">getMimeHeaders</a></strong>()</code>
<div class="block">Returns all the transport-specific MIME headers for this
<CODE>SOAPMessage</CODE> object in a transport-independent
fashion.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#getProperty(java.lang.String)">getProperty</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property)</code>
<div class="block">Retrieves value of the specified property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../javax/xml/soap/SOAPBody.html" title="interface in javax.xml.soap">SOAPBody</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPBody()">getSOAPBody</a></strong>()</code>
<div class="block">Gets the SOAP Body contained in this <code>SOAPMessage</code> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../javax/xml/soap/SOAPHeader.html" title="interface in javax.xml.soap">SOAPHeader</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPHeader()">getSOAPHeader</a></strong>()</code>
<div class="block">Gets the SOAP Header contained in this <code>SOAPMessage</code> object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap">SOAPPart</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#getSOAPPart()">getSOAPPart</a></strong>()</code>
<div class="block">Gets the SOAP part of this <CODE>SOAPMessage</CODE> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#removeAllAttachments()">removeAllAttachments</a></strong>()</code>
<div class="block">Removes all <CODE>AttachmentPart</CODE> objects that have
been added to this <CODE>SOAPMessage</CODE> object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#saveChanges()">saveChanges</a></strong>()</code>
<div class="block">Updates this <CODE>SOAPMessage</CODE> object with all the
changes that have been made to it.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#saveRequired()">saveRequired</a></strong>()</code>
<div class="block">Indicates whether this <CODE>SOAPMessage</CODE> object
has had the method <CODE>saveChanges</CODE> called on
it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#setContentDescription(java.lang.String)">setContentDescription</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;description)</code>
<div class="block">Sets the description of this <CODE>SOAPMessage</CODE>
object's content with the given description.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#setProperty(java.lang.String,%20java.lang.Object)">setProperty</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">Associates the specified value with the specified property.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPMessage.html#writeTo(java.io.OutputStream)">writeTo</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out)</code>
<div class="block">Writes this <CODE>SOAPMessage</CODE> object to the given
output stream.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CHARACTER_SET_ENCODING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CHARACTER_SET_ENCODING</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CHARACTER_SET_ENCODING</pre>
<div class="block">Specifies the character type encoding for the SOAP Message.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#javax.xml.soap.SOAPMessage.CHARACTER_SET_ENCODING">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="WRITE_XML_DECLARATION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WRITE_XML_DECLARATION</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> WRITE_XML_DECLARATION</pre>
<div class="block">Specifies whether the SOAP Message should contain an XML declaration.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#javax.xml.soap.SOAPMessage.WRITE_XML_DECLARATION">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SOAPMessage()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SOAPMessage</h4>
<pre>public&nbsp;SOAPMessage()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getContentDescription()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentDescription</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getContentDescription()</pre>
<div class="block">Retrieves a description of this <CODE>SOAPMessage</CODE>
object's content.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <CODE>String</CODE> describing the content of this
message or <CODE>null</CODE> if no description has been
set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/xml/soap/SOAPMessage.html#setContentDescription(java.lang.String)"><code>setContentDescription(java.lang.String)</code></a></dd></dl>
</li>
</ul>
<a name="setContentDescription(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContentDescription</h4>
<pre>public abstract&nbsp;void&nbsp;setContentDescription(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;description)</pre>
<div class="block">Sets the description of this <CODE>SOAPMessage</CODE>
object's content with the given description.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>description</code> - a <CODE>String</CODE>
describing the content of this message</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/xml/soap/SOAPMessage.html#getContentDescription()"><code>getContentDescription()</code></a></dd></dl>
</li>
</ul>
<a name="getSOAPPart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSOAPPart</h4>
<pre>public abstract&nbsp;<a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap">SOAPPart</a>&nbsp;getSOAPPart()</pre>
<div class="block">Gets the SOAP part of this <CODE>SOAPMessage</CODE> object.
<P>If a <CODE>SOAPMessage</CODE> object contains one or
more attachments, the SOAP Part must be the first MIME body
part in the message.</P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <CODE>SOAPPart</CODE> object for this <CODE>
SOAPMessage</CODE> object</dd></dl>
</li>
</ul>
<a name="removeAllAttachments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllAttachments</h4>
<pre>public abstract&nbsp;void&nbsp;removeAllAttachments()</pre>
<div class="block">Removes all <CODE>AttachmentPart</CODE> objects that have
been added to this <CODE>SOAPMessage</CODE> object.
<P>This method does not touch the SOAP part.</P></div>
</li>
</ul>
<a name="countAttachments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>countAttachments</h4>
<pre>public abstract&nbsp;int&nbsp;countAttachments()</pre>
<div class="block">Gets a count of the number of attachments in this
message. This count does not include the SOAP part.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of <CODE>AttachmentPart</CODE> objects
that are part of this <CODE>SOAPMessage</CODE>
object</dd></dl>
</li>
</ul>
<a name="getAttachments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachments</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&nbsp;getAttachments()</pre>
<div class="block">Retrieves all the <CODE>AttachmentPart</CODE> objects
that are part of this <CODE>SOAPMessage</CODE> object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an iterator over all the attachments in this
message</dd></dl>
</li>
</ul>
<a name="getAttachments(javax.xml.soap.MimeHeaders)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttachments</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&nbsp;getAttachments(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a>&nbsp;headers)</pre>
<div class="block">Retrieves all the <CODE>AttachmentPart</CODE> objects
that have header entries that match the specified headers.
Note that a returned attachment could have headers in
addition to those specified.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>headers</code> - a <CODE>MimeHeaders</CODE>
object containing the MIME headers for which to
search</dd>
<dt><span class="strong">Returns:</span></dt><dd>an iterator over all attachments that have a header
that matches one of the given headers</dd></dl>
</li>
</ul>
<a name="addAttachmentPart(javax.xml.soap.AttachmentPart)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAttachmentPart</h4>
<pre>public abstract&nbsp;void&nbsp;addAttachmentPart(<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a>&nbsp;attachmentpart)</pre>
<div class="block">Adds the given <CODE>AttachmentPart</CODE> object to this
<CODE>SOAPMessage</CODE> object. An <CODE>
AttachmentPart</CODE> object must be created before it can be
added to a message.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>attachmentpart</code> - an <CODE>
AttachmentPart</CODE> object that is to become part of
this <CODE>SOAPMessage</CODE> object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd></dl>
</li>
</ul>
<a name="createAttachmentPart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAttachmentPart</h4>
<pre>public abstract&nbsp;<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a>&nbsp;createAttachmentPart()</pre>
<div class="block">Creates a new empty <CODE>AttachmentPart</CODE> object.
Note that the method <CODE>addAttachmentPart</CODE> must be
called with this new <CODE>AttachmentPart</CODE> object as
the parameter in order for it to become an attachment to this
<CODE>SOAPMessage</CODE> object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a new <CODE>AttachmentPart</CODE> object that can be
populated and added to this <CODE>SOAPMessage</CODE>
object</dd></dl>
</li>
</ul>
<a name="createAttachmentPart(javax.activation.DataHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAttachmentPart</h4>
<pre>public&nbsp;<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a>&nbsp;createAttachmentPart(<a href="http://download.oracle.com/javaee/1.4/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation">DataHandler</a>&nbsp;datahandler)</pre>
<div class="block">Creates an <CODE>AttachmentPart</CODE> object and
populates it using the given <CODE>DataHandler</CODE>
object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>datahandler</code> - the <CODE>
javax.activation.DataHandler</CODE> object that will
generate the content for this <CODE>SOAPMessage</CODE>
object</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new <CODE>AttachmentPart</CODE> object that
contains data generated by the given <CODE>
DataHandler</CODE> object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if
there was a problem with the specified <CODE>
DataHandler</CODE> object</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://download.oracle.com/javaee/1.4/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation"><code>DataHandler</code></a>,
<a href="http://download.oracle.com/javaee/1.4/api/javax/activation/DataContentHandler.html?is-external=true" title="class or interface in javax.activation"><code>DataContentHandler</code></a></dd></dl>
</li>
</ul>
<a name="getMimeHeaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMimeHeaders</h4>
<pre>public abstract&nbsp;<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a>&nbsp;getMimeHeaders()</pre>
<div class="block">Returns all the transport-specific MIME headers for this
<CODE>SOAPMessage</CODE> object in a transport-independent
fashion.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a <CODE>MimeHeaders</CODE> object containing the
<CODE>MimeHeader</CODE> objects</dd></dl>
</li>
</ul>
<a name="createAttachmentPart(java.lang.Object, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAttachmentPart</h4>
<pre>public&nbsp;<a href="../../../javax/xml/soap/AttachmentPart.html" title="class in javax.xml.soap">AttachmentPart</a>&nbsp;createAttachmentPart(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;content,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;contentType)</pre>
<div class="block">Creates an <CODE>AttachmentPart</CODE> object and
populates it with the specified data of the specified content
type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>content</code> - an <CODE>Object</CODE>
containing the content for this <CODE>SOAPMessage</CODE>
object</dd><dd><code>contentType</code> - a <CODE>String</CODE>
object giving the type of content; examples are
"text/xml", "text/plain", and "image/jpeg"</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new <CODE>AttachmentPart</CODE> object that
contains the given data</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the contentType does not match the type of the content
object, or if there was no <CODE>
DataContentHandler</CODE> object for the given content
object</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://download.oracle.com/javaee/1.4/api/javax/activation/DataHandler.html?is-external=true" title="class or interface in javax.activation"><code>DataHandler</code></a>,
<a href="http://download.oracle.com/javaee/1.4/api/javax/activation/DataContentHandler.html?is-external=true" title="class or interface in javax.activation"><code>DataContentHandler</code></a></dd></dl>
</li>
</ul>
<a name="saveChanges()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveChanges</h4>
<pre>public abstract&nbsp;void&nbsp;saveChanges()
throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">Updates this <CODE>SOAPMessage</CODE> 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 <CODE>ProviderConnection.send</CODE>, <CODE>
SOAPConnection.call</CODE>, or <CODE>
SOAPMessage.writeTo</CODE>. However, if changes are made to
a message that was received or to one that has already been
sent, the method <CODE>saveChanges</CODE> needs to be
called explicitly in order to save the changes. The method
<CODE>saveChanges</CODE> 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 <CODE>saveChanges</CODE> has been
called.
<P>In addition, this method marks the point at which the
data from all constituent <CODE>AttachmentPart</CODE>
objects are pulled into the message.</P></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if there
was a problem saving changes to this message.</dd></dl>
</li>
</ul>
<a name="saveRequired()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveRequired</h4>
<pre>public abstract&nbsp;boolean&nbsp;saveRequired()</pre>
<div class="block">Indicates whether this <CODE>SOAPMessage</CODE> object
has had the method <CODE>saveChanges</CODE> called on
it.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><CODE>true</CODE> if <CODE>saveChanges</CODE> has
been called on this message at least once; <CODE>
false</CODE> otherwise.</dd></dl>
</li>
</ul>
<a name="writeTo(java.io.OutputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeTo</h4>
<pre>public abstract&nbsp;void&nbsp;writeTo(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out)
throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a>,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes this <CODE>SOAPMessage</CODE> object to the given
output stream. The externalization format is as defined by
the SOAP 1.1 with Attachments specification.
<P>If there are no attachments, just an XML stream is
written out. For those messages that have attachments,
<CODE>writeTo</CODE> writes a MIME-encoded byte stream.</P></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the <CODE>OutputStream</CODE>
object to which this <CODE>SOAPMessage</CODE> object will
be written</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if there was a problem in
externalizing this SOAP message</dd>
<dd><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error
occurs</dd></dl>
</li>
</ul>
<a name="getSOAPBody()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSOAPBody</h4>
<pre>public&nbsp;<a href="../../../javax/xml/soap/SOAPBody.html" title="interface in javax.xml.soap">SOAPBody</a>&nbsp;getSOAPBody()
throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">Gets the SOAP Body contained in this <code>SOAPMessage</code> object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>SOAPBody</code> object contained by this
<code>SOAPMessage</code> object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if the SOAP Body does not exist or cannot be
retrieved</dd></dl>
</li>
</ul>
<a name="getSOAPHeader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSOAPHeader</h4>
<pre>public&nbsp;<a href="../../../javax/xml/soap/SOAPHeader.html" title="interface in javax.xml.soap">SOAPHeader</a>&nbsp;getSOAPHeader()
throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">Gets the SOAP Header contained in this <code>SOAPMessage</code> object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>SOAPHeader</code> object contained by this
<code>SOAPMessage</code> object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if the SOAP Header does not exist or cannot be
retrieved</dd></dl>
</li>
</ul>
<a name="setProperty(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>public&nbsp;void&nbsp;setProperty(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property,
<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)
throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">Associates the specified value with the specified property. If there was
already a value associated with this property, the old value is replaced.
<p>
The valid property names include <code>WRITE_XML_DECLARATION</code> and
<code>CHARACTER_SET_ENCODING</code>. 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.
<p>
Setting the property <code>WRITE_XML_DECLARATION</code> to
<code>"true"</code> will cause an XML Declaration to be written out at
the start of the SOAP message. The default value of "false" suppresses
this declaration.
<p>
The property <code>CHARACTER_SET_ENCODING</code> defaults to the value
<code>"utf-8"</code> which causes the SOAP message to be encoded using
UTF-8. Setting <code>CHARACTER_SET_ENCODING</code> to
<code>"utf-16"</code> causes the SOAP message to be encoded using UTF-16.
<p>
Some implementations may allow encodings in addition to UTF-8 and UTF-16.
Refer to your vendor's documentation for details.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - the property with which the specified value is to be
associated</dd><dd><code>value</code> - the value to be associated with the specified property</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if the property name is not recognized</dd></dl>
</li>
</ul>
<a name="getProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getProperty</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getProperty(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;property)
throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">Retrieves value of the specified property.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - the name of the property to retrieve</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of the property or <code>null</code> if no such
property exists</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if the property name is not recognized</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SOAPMessage.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../javax/xml/soap/SOAPHeaderElement.html" title="interface in javax.xml.soap"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../javax/xml/soap/SOAPPart.html" title="class in javax.xml.soap"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/soap/SOAPMessage.html" target="_top">Frames</a></li>
<li><a href="SOAPMessage.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>