| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_22) on Tue Apr 17 18:33:49 IST 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| SOAPMessageImpl (Apache Axis2 - Root 1.6.2 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-04-17"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SOAPMessageImpl (Apache Axis2 - Root 1.6.2 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SOAPMessageImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/axis2/saaj/SOAPHeaderImpl.html" title="class in org.apache.axis2.saaj"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/axis2/saaj/SOAPPartImpl.html" title="class in org.apache.axis2.saaj"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/axis2/saaj/SOAPMessageImpl.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SOAPMessageImpl.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_javax.xml.soap.SOAPMessage">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.axis2.saaj</FONT> |
| <BR> |
| Class SOAPMessageImpl</H2> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">javax.xml.soap.SOAPMessage</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.axis2.saaj.SOAPMessageImpl</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>SOAPMessageImpl</B><DT>extends <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></DL> |
| </PRE> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_javax.xml.soap.SOAPMessage"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class javax.xml.soap.<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#CHARACTER_SET_ENCODING" title="class or interface in javax.xml.soap">CHARACTER_SET_ENCODING</A>, <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#WRITE_XML_DECLARATION" title="class or interface in javax.xml.soap">WRITE_XML_DECLARATION</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#SOAPMessageImpl(java.io.InputStream, javax.xml.soap.MimeHeaders, boolean)">SOAPMessageImpl</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> inputstream, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap">MimeHeaders</A> mimeHeaders, |
| boolean processMTOM)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#SOAPMessageImpl(org.apache.axis2.saaj.SOAPEnvelopeImpl)">SOAPMessageImpl</A></B>(<A HREF="../../../../org/apache/axis2/saaj/SOAPEnvelopeImpl.html" title="class in org.apache.axis2.saaj">SOAPEnvelopeImpl</A> soapEnvelope)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#addAttachmentPart(javax.xml.soap.AttachmentPart)">addAttachmentPart</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap">AttachmentPart</A> attachmentPart)</CODE> |
| |
| <BR> |
| Adds the given <CODE>AttachmentPart</CODE> object to this <CODE>SOAPMessage</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#countAttachments()">countAttachments</A></B>()</CODE> |
| |
| <BR> |
| Gets a count of the number of attachments in this message.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap">AttachmentPart</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#createAttachmentPart()">createAttachmentPart</A></B>()</CODE> |
| |
| <BR> |
| Creates a new empty <CODE>AttachmentPart</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap">AttachmentPart</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#getAttachment(javax.xml.soap.SOAPElement)">getAttachment</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPElement.html?is-external=true" title="class or interface in javax.xml.soap">SOAPElement</A> soapelement)</CODE> |
| |
| <BR> |
| Returns an AttachmentPart object that is associated with an attachment that is referenced by |
| this SOAPElement or null if no such attachment exists.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#getAttachments()">getAttachments</A></B>()</CODE> |
| |
| <BR> |
| Retrieves all the <CODE>AttachmentPart</CODE> objects that are part of this |
| <CODE>SOAPMessage</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#getAttachments(javax.xml.soap.MimeHeaders)">getAttachments</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap">MimeHeaders</A> headers)</CODE> |
| |
| <BR> |
| Retrieves all the AttachmentPart objects that have header entries that match the specified |
| headers.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#getContentDescription()">getContentDescription</A></B>()</CODE> |
| |
| <BR> |
| Retrieves a description of this <CODE>SOAPMessage</CODE> object's content.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap">MimeHeaders</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#getMimeHeaders()">getMimeHeaders</A></B>()</CODE> |
| |
| <BR> |
| Returns all the transport-specific MIME headers for this <CODE>SOAPMessage</CODE> object in a |
| transport-independent fashion.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#getProperty(java.lang.String)">getProperty</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> property)</CODE> |
| |
| <BR> |
| Retrieves value of the specified property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPBody.html?is-external=true" title="class or interface in javax.xml.soap">SOAPBody</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#getSOAPBody()">getSOAPBody</A></B>()</CODE> |
| |
| <BR> |
| Gets the SOAP Body contained in this <code>SOAPMessage</code> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPHeader.html?is-external=true" title="class or interface in javax.xml.soap">SOAPHeader</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#getSOAPHeader()">getSOAPHeader</A></B>()</CODE> |
| |
| <BR> |
| Gets the SOAP Header contained in this <code>SOAPMessage</code> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPPart.html?is-external=true" title="class or interface in javax.xml.soap">SOAPPart</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#getSOAPPart()">getSOAPPart</A></B>()</CODE> |
| |
| <BR> |
| Gets the SOAP part of this <CODE>SOAPMessage</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#removeAllAttachments()">removeAllAttachments</A></B>()</CODE> |
| |
| <BR> |
| Removes all <CODE>AttachmentPart</CODE> objects that have been added to this |
| <CODE>SOAPMessage</CODE> object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#removeAttachments(javax.xml.soap.MimeHeaders)">removeAttachments</A></B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap">MimeHeaders</A> headers)</CODE> |
| |
| <BR> |
| Removes all the AttachmentPart objects that have header entries that match the specified |
| headers.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#saveChanges()">saveChanges</A></B>()</CODE> |
| |
| <BR> |
| Updates this <CODE>SOAPMessage</CODE> object with all the changes that have been made to it.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#saveRequired()">saveRequired</A></B>()</CODE> |
| |
| <BR> |
| Indicates whether this <CODE>SOAPMessage</CODE> object has had the method <A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#saveChanges()"><CODE>saveChanges()</CODE></A> called on it.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#setContentDescription(java.lang.String)">setContentDescription</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> description)</CODE> |
| |
| <BR> |
| Sets the description of this <CODE>SOAPMessage</CODE> object's content with the given |
| description.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#setProperty(java.lang.String, java.lang.Object)">setProperty</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> property, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)</CODE> |
| |
| <BR> |
| Associates the specified value with the specified property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#setSaveRequired()">setSaveRequired</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#writeTo(java.io.OutputStream)">writeTo</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out)</CODE> |
| |
| <BR> |
| Writes this <CODE>SOAPMessage</CODE> object to the given output stream.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_javax.xml.soap.SOAPMessage"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class javax.xml.soap.<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#createAttachmentPart(javax.activation.DataHandler)" title="class or interface in javax.xml.soap">createAttachmentPart</A>, <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#createAttachmentPart(java.lang.Object, java.lang.String)" title="class or interface in javax.xml.soap">createAttachmentPart</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/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://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="SOAPMessageImpl(org.apache.axis2.saaj.SOAPEnvelopeImpl)"><!-- --></A><H3> |
| SOAPMessageImpl</H3> |
| <PRE> |
| public <B>SOAPMessageImpl</B>(<A HREF="../../../../org/apache/axis2/saaj/SOAPEnvelopeImpl.html" title="class in org.apache.axis2.saaj">SOAPEnvelopeImpl</A> soapEnvelope)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SOAPMessageImpl(java.io.InputStream, javax.xml.soap.MimeHeaders, boolean)"><!-- --></A><H3> |
| SOAPMessageImpl</H3> |
| <PRE> |
| public <B>SOAPMessageImpl</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> inputstream, |
| <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap">MimeHeaders</A> mimeHeaders, |
| boolean processMTOM) |
| throws <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></CODE></DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getContentDescription()"><!-- --></A><H3> |
| getContentDescription</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getContentDescription</B>()</PRE> |
| <DL> |
| <DD>Retrieves a description of this <CODE>SOAPMessage</CODE> object's content. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getContentDescription()" title="class or interface in javax.xml.soap">getContentDescription</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a <CODE>String</CODE> describing the content of this message or <CODE>null</CODE> if |
| no description has been set<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#setContentDescription(java.lang.String)"><CODE>setContentDescription(java.lang.String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setContentDescription(java.lang.String)"><!-- --></A><H3> |
| setContentDescription</H3> |
| <PRE> |
| public void <B>setContentDescription</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> description)</PRE> |
| <DL> |
| <DD>Sets the description of this <CODE>SOAPMessage</CODE> object's content with the given |
| description. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#setContentDescription(java.lang.String)" title="class or interface in javax.xml.soap">setContentDescription</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>description</CODE> - a <CODE>String</CODE> describing the content of this message<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#getContentDescription()"><CODE>getContentDescription()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSOAPPart()"><!-- --></A><H3> |
| getSOAPPart</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPPart.html?is-external=true" title="class or interface in javax.xml.soap">SOAPPart</A> <B>getSOAPPart</B>()</PRE> |
| <DL> |
| <DD>Gets the SOAP part of this <CODE>SOAPMessage</CODE> object. |
| <p/> |
| <p/> |
| <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> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getSOAPPart()" title="class or interface in javax.xml.soap">getSOAPPart</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <CODE>SOAPPart</CODE> object for this <CODE> SOAPMessage</CODE> object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAllAttachments()"><!-- --></A><H3> |
| removeAllAttachments</H3> |
| <PRE> |
| public void <B>removeAllAttachments</B>()</PRE> |
| <DL> |
| <DD>Removes all <CODE>AttachmentPart</CODE> objects that have been added to this |
| <CODE>SOAPMessage</CODE> object. |
| <p/> |
| <P>This method does not touch the SOAP part.</P> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#removeAllAttachments()" title="class or interface in javax.xml.soap">removeAllAttachments</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="countAttachments()"><!-- --></A><H3> |
| countAttachments</H3> |
| <PRE> |
| public int <B>countAttachments</B>()</PRE> |
| <DL> |
| <DD>Gets a count of the number of attachments in this message. This count does not include the |
| SOAP part. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#countAttachments()" title="class or interface in javax.xml.soap">countAttachments</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the number of <CODE>AttachmentPart</CODE> objects that are part of this |
| <CODE>SOAPMessage</CODE> object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAttachments()"><!-- --></A><H3> |
| getAttachments</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A> <B>getAttachments</B>()</PRE> |
| <DL> |
| <DD>Retrieves all the <CODE>AttachmentPart</CODE> objects that are part of this |
| <CODE>SOAPMessage</CODE> object. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getAttachments()" title="class or interface in javax.xml.soap">getAttachments</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>an iterator over all the attachments in this message</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAttachments(javax.xml.soap.MimeHeaders)"><!-- --></A><H3> |
| getAttachments</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A> <B>getAttachments</B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap">MimeHeaders</A> headers)</PRE> |
| <DL> |
| <DD>Retrieves all the AttachmentPart objects that have header entries that match the specified |
| headers. Note that a returned attachment could have headers in addition to those specified. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getAttachments(javax.xml.soap.MimeHeaders)" title="class or interface in javax.xml.soap">getAttachments</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>headers</CODE> - a <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap"><CODE>MimeHeaders</CODE></A> object containing the MIME headers for |
| which to search |
| <DT><B>Returns:</B><DD>an iterator over all attachments(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap"><CODE>AttachmentPart</CODE></A>) that have a |
| header that matches one of the given headers</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addAttachmentPart(javax.xml.soap.AttachmentPart)"><!-- --></A><H3> |
| addAttachmentPart</H3> |
| <PRE> |
| public void <B>addAttachmentPart</B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap">AttachmentPart</A> attachmentPart)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#addAttachmentPart(javax.xml.soap.AttachmentPart)" title="class or interface in javax.xml.soap">addAttachmentPart</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>attachmentPart</CODE> - an <CODE> AttachmentPart</CODE> object that is to become part of this |
| <CODE>SOAPMessage</CODE> object |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createAttachmentPart()"><!-- --></A><H3> |
| createAttachmentPart</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap">AttachmentPart</A> <B>createAttachmentPart</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#createAttachmentPart()" title="class or interface in javax.xml.soap">createAttachmentPart</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a new <CODE>AttachmentPart</CODE> object that can be populated and added to this |
| <CODE>SOAPMessage</CODE> object</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMimeHeaders()"><!-- --></A><H3> |
| getMimeHeaders</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap">MimeHeaders</A> <B>getMimeHeaders</B>()</PRE> |
| <DL> |
| <DD>Returns all the transport-specific MIME headers for this <CODE>SOAPMessage</CODE> object in a |
| transport-independent fashion. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getMimeHeaders()" title="class or interface in javax.xml.soap">getMimeHeaders</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a <CODE>MimeHeaders</CODE> object containing the <CODE>MimeHeader</CODE> objects</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="saveChanges()"><!-- --></A><H3> |
| saveChanges</H3> |
| <PRE> |
| public void <B>saveChanges</B>() |
| throws <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>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/> |
| <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> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#saveChanges()" title="class or interface in javax.xml.soap">saveChanges</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></CODE> - if there was a problem saving changes to this message.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSaveRequired()"><!-- --></A><H3> |
| setSaveRequired</H3> |
| <PRE> |
| public void <B>setSaveRequired</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="saveRequired()"><!-- --></A><H3> |
| saveRequired</H3> |
| <PRE> |
| public boolean <B>saveRequired</B>()</PRE> |
| <DL> |
| <DD>Indicates whether this <CODE>SOAPMessage</CODE> object has had the method <A HREF="../../../../org/apache/axis2/saaj/SOAPMessageImpl.html#saveChanges()"><CODE>saveChanges()</CODE></A> called on it. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#saveRequired()" title="class or interface in javax.xml.soap">saveRequired</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><CODE>true</CODE> if <CODE>saveChanges</CODE> has been called on this message at |
| least once; <CODE> false</CODE> otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="writeTo(java.io.OutputStream)"><!-- --></A><H3> |
| writeTo</H3> |
| <PRE> |
| public void <B>writeTo</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> out) |
| throws <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A>, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>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/> |
| <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> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#writeTo(java.io.OutputStream)" title="class or interface in javax.xml.soap">writeTo</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>out</CODE> - the <CODE>OutputStream</CODE> object to which this <CODE>SOAPMessage</CODE> object |
| will be written |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></CODE> - if there was a problem in externalizing this SOAP message |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/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</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| setProperty</H3> |
| <PRE> |
| public void <B>setProperty</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> property, |
| <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#setProperty(java.lang.String, java.lang.Object)" title="class or interface in javax.xml.soap">setProperty</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - the property with which the specified value is to be associated<DD><CODE>value</CODE> - the value to be associated with the specified property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProperty(java.lang.String)"><!-- --></A><H3> |
| getProperty</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getProperty</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> property) |
| throws <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Retrieves value of the specified property. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getProperty(java.lang.String)" title="class or interface in javax.xml.soap">getProperty</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>property</CODE> - the name of the property to retrieve |
| <DT><B>Returns:</B><DD>the value of the property or <code>null</code> if no such property exists |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></CODE> - if the property name is not recognized</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAttachment(javax.xml.soap.SOAPElement)"><!-- --></A><H3> |
| getAttachment</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/AttachmentPart.html?is-external=true" title="class or interface in javax.xml.soap">AttachmentPart</A> <B>getAttachment</B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPElement.html?is-external=true" title="class or interface in javax.xml.soap">SOAPElement</A> soapelement) |
| throws <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Returns an AttachmentPart object that is associated with an attachment that is referenced by |
| this SOAPElement or null if no such attachment exists. References can be made via an href |
| attribute as described in SOAP Messages with Attachments (http://www.w3.org/TR/SOAPattachments#SOAPReferenceToAttachements) |
| , or via a single Text child node containing a URI as described in the WS-I Attachments |
| Profile 1.0 for elements of schema type ref:swaRef(ref:swaRef (http://www.wsi.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html") |
| ). These two mechanisms must be supported. The support for references via href attribute also |
| implies that this method should also be supported on an element that is an xop:Include |
| element (XOP (http://www.w3.org/2000/xp/Group/3/06/Attachments/XOP.html) ). other reference |
| mechanisms may be supported by individual implementations of this standard. Contact your |
| vendor for details. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getAttachment(javax.xml.soap.SOAPElement)" title="class or interface in javax.xml.soap">getAttachment</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>element</CODE> - - The SOAPElement containing the reference to an Attachment |
| <DT><B>Returns:</B><DD>the referenced AttachmentPart or null if no such AttachmentPart exists or no |
| reference can be found in this SOAPElement. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></CODE> - - if there is an error in the attempt to access the attachment</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAttachments(javax.xml.soap.MimeHeaders)"><!-- --></A><H3> |
| removeAttachments</H3> |
| <PRE> |
| public void <B>removeAttachments</B>(<A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/MimeHeaders.html?is-external=true" title="class or interface in javax.xml.soap">MimeHeaders</A> headers)</PRE> |
| <DL> |
| <DD>Removes all the AttachmentPart objects that have header entries that match the specified |
| headers. Note that the removed attachment could have headers in addition to those specified. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#removeAttachments(javax.xml.soap.MimeHeaders)" title="class or interface in javax.xml.soap">removeAttachments</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>headers</CODE> - - a MimeHeaders object containing the MIME headers for which to search<DT><B>Since:</B></DT> |
| <DD>SAAJ 1.3</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSOAPHeader()"><!-- --></A><H3> |
| getSOAPHeader</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPHeader.html?is-external=true" title="class or interface in javax.xml.soap">SOAPHeader</A> <B>getSOAPHeader</B>() |
| throws <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Gets the SOAP Header contained in this <code>SOAPMessage</code> object. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getSOAPHeader()" title="class or interface in javax.xml.soap">getSOAPHeader</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <code>SOAPHeader</code> object contained by this <code>SOAPMessage</code> object |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></CODE> - if the SOAP Header does not exist or cannot be |
| retrieved</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSOAPBody()"><!-- --></A><H3> |
| getSOAPBody</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPBody.html?is-external=true" title="class or interface in javax.xml.soap">SOAPBody</A> <B>getSOAPBody</B>() |
| throws <A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></PRE> |
| <DL> |
| <DD>Gets the SOAP Body contained in this <code>SOAPMessage</code> object. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true#getSOAPBody()" title="class or interface in javax.xml.soap">getSOAPBody</A></CODE> in class <CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPMessage.html?is-external=true" title="class or interface in javax.xml.soap">SOAPMessage</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <code>SOAPBody</code> object contained by this <code>SOAPMessage</code> object |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javaee/5/docs/api/javax/xml/soap/SOAPException.html?is-external=true" title="class or interface in javax.xml.soap">SOAPException</A></CODE> - if the SOAP Body does not exist or cannot be retrieved</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SOAPMessageImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/axis2/saaj/SOAPHeaderImpl.html" title="class in org.apache.axis2.saaj"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/axis2/saaj/SOAPPartImpl.html" title="class in org.apache.axis2.saaj"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/axis2/saaj/SOAPMessageImpl.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SOAPMessageImpl.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_javax.xml.soap.SOAPMessage">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2012 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |