| <!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>MessageFactory (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="MessageFactory (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/MessageFactory.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/DetailEntry.html" title="interface in javax.xml.soap"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../javax/xml/soap/MimeHeader.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/MessageFactory.html" target="_top">Frames</a></li> |
| <li><a href="MessageFactory.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 MessageFactory" class="title">Class MessageFactory</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.MessageFactory</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/soap/MessageFactoryImpl.html" title="class in org.apache.axis.soap">MessageFactoryImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">MessageFactory</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>A factory for creating <CODE>SOAPMessage</CODE> objects.</P> |
| |
| <P>A JAXM client performs the following steps to create a |
| message.</P> |
| |
| <UL> |
| <LI> |
| Creates a <CODE>MessageFactory</CODE> object from a <CODE> |
| ProviderConnection</CODE> object (<CODE>con</CODE> in the |
| following line of code). The <CODE>String</CODE> passed to |
| the <CODE>createMessageFactory</CODE> method is the name of |
| of a messaging profile, which must be the URL for the |
| schema. |
| <PRE> |
| MessageFactory mf = con.createMessageFactory(schemaURL); |
| </PRE> |
| </LI> |
| |
| <LI> |
| Calls the method <CODE>createMessage</CODE> on the <CODE> |
| MessageFactory</CODE> object. All messages produced by this |
| <CODE>MessageFactory</CODE> object will have the header |
| information appropriate for the messaging profile that was |
| specified when the <CODE>MessageFactory</CODE> object was |
| created. |
| <PRE> |
| SOAPMessage m = mf.createMessage(); |
| </PRE> |
| </LI> |
| </UL> |
| It is also possible to create a <CODE>MessageFactory</CODE> |
| object using the method <CODE>newInstance</CODE>, as shown in |
| the following line of code. |
| <PRE> |
| MessageFactory mf = MessageFactory.newInstance(); |
| </PRE> |
| A standalone client (a client that is not running in a |
| container) can use the <CODE>newInstance</CODE> method to |
| create a <CODE>MessageFactory</CODE> object. |
| |
| <P>All <CODE>MessageFactory</CODE> objects, regardless of how |
| they are created, will produce <CODE>SOAPMessage</CODE> objects |
| that have the following elements 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> |
| If a <CODE>MessageFactory</CODE> object was created using a |
| <CODE>ProviderConnection</CODE> object, which means that it was |
| initialized with a specified profile, it will produce messages |
| that also come prepopulated with additional entries in the |
| <CODE>SOAPHeader</CODE> object and the <CODE>SOAPBody</CODE> |
| object. The content of a new <CODE>SOAPMessage</CODE> object |
| depends on which of the two <CODE>MessageFactory</CODE> methods |
| is used to create it. |
| |
| <UL> |
| <LI><CODE>createMessage()</CODE> -- message has no |
| content<BR> |
| This is the method clients would normally use to create a |
| request message.</LI> |
| |
| <LI><CODE>createMessage(MimeHeaders, |
| java.io.InputStream)</CODE> -- message has content from the |
| <CODE>InputStream</CODE> object and headers from the <CODE> |
| MimeHeaders</CODE> object<BR> |
| This method can be used internally by a service |
| implementation to create a message that is a response to a |
| request.</LI> |
| </UL></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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/MessageFactory.html#MessageFactory()">MessageFactory</a></strong>()</code> |
| <div class="block">Create a new MessageFactory.</div> |
| </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"> </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 <a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/xml/soap/MessageFactory.html#createMessage()">createMessage</a></strong>()</code> |
| <div class="block">Creates a new <CODE>SOAPMessage</CODE> object with the |
| default <CODE>SOAPPart</CODE>, <CODE>SOAPEnvelope</CODE>, |
| <CODE>SOAPBody</CODE>, and <CODE>SOAPHeader</CODE> objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/xml/soap/MessageFactory.html#createMessage(javax.xml.soap.MimeHeaders,%20java.io.InputStream)">createMessage</a></strong>(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> mimeheaders, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> inputstream)</code> |
| <div class="block">Internalizes the contents of the given <CODE> |
| InputStream</CODE> object into a new <CODE>SOAPMessage</CODE> |
| object and returns the <CODE>SOAPMessage</CODE> object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../javax/xml/soap/MessageFactory.html" title="class in javax.xml.soap">MessageFactory</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../javax/xml/soap/MessageFactory.html#newInstance()">newInstance</a></strong>()</code> |
| <div class="block">Creates a new <CODE>MessageFactory</CODE> object that is |
| an instance of the default implementation.</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 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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MessageFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MessageFactory</h4> |
| <pre>public MessageFactory()</pre> |
| <div class="block">Create a new MessageFactory.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="newInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newInstance</h4> |
| <pre>public static <a href="../../../javax/xml/soap/MessageFactory.html" title="class in javax.xml.soap">MessageFactory</a> newInstance() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Creates a new <CODE>MessageFactory</CODE> object that is |
| an instance of the default implementation.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <CODE>MessageFactory</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 there was an error in |
| creating the default implementation of the <CODE> |
| MessageFactory</CODE></dd></dl> |
| </li> |
| </ul> |
| <a name="createMessage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createMessage</h4> |
| <pre>public abstract <a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a> createMessage() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Creates a new <CODE>SOAPMessage</CODE> object with the |
| default <CODE>SOAPPart</CODE>, <CODE>SOAPEnvelope</CODE>, |
| <CODE>SOAPBody</CODE>, and <CODE>SOAPHeader</CODE> objects. |
| Profile-specific message factories can choose to |
| prepopulate the <CODE>SOAPMessage</CODE> object with |
| profile-specific headers. |
| |
| <P>Content can be added to this message's <CODE> |
| SOAPPart</CODE> object, and the message can be sent "as is" |
| when a message containing only a SOAP part is sufficient. |
| Otherwise, the <CODE>SOAPMessage</CODE> object needs to |
| create one or more <CODE>AttachmentPart</CODE> objects and |
| add them to itself. Any content that is not in XML format |
| must be in an <CODE>AttachmentPart</CODE> object.</P></div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a new <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 a SOAP error occurs</dd></dl> |
| </li> |
| </ul> |
| <a name="createMessage(javax.xml.soap.MimeHeaders, java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createMessage</h4> |
| <pre>public abstract <a href="../../../javax/xml/soap/SOAPMessage.html" title="class in javax.xml.soap">SOAPMessage</a> createMessage(<a href="../../../javax/xml/soap/MimeHeaders.html" title="class in javax.xml.soap">MimeHeaders</a> mimeheaders, |
| <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> inputstream) |
| throws <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>, |
| <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Internalizes the contents of the given <CODE> |
| InputStream</CODE> object into a new <CODE>SOAPMessage</CODE> |
| object and returns the <CODE>SOAPMessage</CODE> object.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mimeheaders</code> - the transport-specific headers |
| passed to the message in a transport-independent fashion |
| for creation of the message</dd><dd><code>inputstream</code> - the <CODE>InputStream</CODE> object |
| that contains the data for a message</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new <CODE>SOAPMessage</CODE> object containing the |
| data from the given <CODE>InputStream</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/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is a |
| problem in reading data from the input stream</dd> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if the message is invalid</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/MessageFactory.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/DetailEntry.html" title="interface in javax.xml.soap"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../javax/xml/soap/MimeHeader.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/MessageFactory.html" target="_top">Frames</a></li> |
| <li><a href="MessageFactory.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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> |