Menu
Home
People
Places
Arts
History
Plants & Animals
Science
Life & Culture
Technology
Reference.org
Java API for XML Messaging
open-in-new
<h2 id="overview">Overview</h2> <p>The <a href="/facts/List_of_Java_APIs/nRY3qexv">Java API</a> for XML Messaging (JAXM) enables developers to use <a href="http://www.ibm.com/developerworks/library/co-tutintro.html">XML messaging</a> using the Java platform. Developers can create and send XML messages over the internet using the JAXM API.<a class="footnote-ref" id="fnref:1" href="#fn:1"><sup>1</sup></a> </p> <p>Also, Java API for XML Messaging has several advantages over <a href="/facts/Remote_Procedure_Call/uMMb9CQw">Remote Procedure Call</a> such as the following: </p> <ul><li>One-way (asynchronous) messaging</li> <li>Routing of a message to more than one party</li> <li>Reliable messaging with features such as guaranteed delivery</li></ul> <p>The complete JAXM API comes with two packages:<a class="footnote-ref" id="fnref:2" href="#fn:2"><sup>2</sup></a> </p> <ul><li><a href="http://docs.oracle.com/javaee/7/api/index.html?javax/xml/soap/package-summary.html">javax.xml.soap:</a> This package contains the API for creating and populating a SOAP message.</li> <li><a href="https://javaee.github.io/openmq/www/javadoc/5.0/javadoc/javax/xml/messaging/package-summary.html">javax.xml.messaging:</a> This package allows one to send one-way messages via a messaging provider.</li></ul> <h2 id="messages">Messages</h2> <p>Messages in JAXM are XML messages that follow the prescribed SOAP format and standards. There are two main types of SOAP messages: those that have attachments and those that do not. For example, if you want your message to contain an image, you must send an attachment with the message. The SAAJ API provides the AttachmentPart class for attachments in SOAP messages.<a class="footnote-ref" id="fnref:3" href="#fn:3"><sup>3</sup></a> </p> <h2 id="connections">Connections</h2> <p>A connection is required to send and receive all SOAP messages. The connection can go to a messaging provider or a particular destination.<a class="footnote-ref" id="fnref:4" href="#fn:4"><sup>4</sup></a> The JAXM API provides the class and interface to represent two kinds of connections: </p> <ul><li><a href="http://docs.oracle.com/javaee/1.4/api/javax/xml/soap/SOAPConnection.html">javax.xml.soap.SOAPConnection</a>—a connection from the sender directly to the receiver (a point-to-point connection)</li> <li><a href="http://mq.java.net/nonav/javadoc/4.4/javadoc/javax/xml/messaging/ProviderConnection.html">javax.xml.messaging.ProviderConnection</a>—a connection to a messaging provider</li></ul> <h3>SOAP Connection</h3> <p class="note">See also: <a href="/facts/SOAP_with_Attachments_API_for_Java/Kg5QyHu3">SOAP with Attachments API for Java</a></p> <p>A SOAPConnection is a point-to-point connection for sending messages directly to a remote party.<a class="footnote-ref" id="fnref:5" href="#fn:5"><sup>5</sup></a> A SOAPConnection object, which represents a point-to-point connection, is simple to create and use. You do not have to do any configuration to use a SOAPConnection object because it does not need to run in a servlet container (like Tomcat) or in a J2EE server. It is the only way for a client to have a connection without a service provider.<a class="footnote-ref" id="fnref:6" href="#fn:6"><sup>6</sup></a> </p> <h3>Provider Connection</h3> <p>A ProviderConnection object represents a connection to a messaging provider. (The next section explains more about messaging providers.) When you send a message via a ProviderConnection object, the message goes to the messaging provider. The messaging provider forwards the message, following the message's routing instructions, until the message gets to the ultimate recipient's messaging provider, which in turn forwards the message to the ultimate recipient.<a class="footnote-ref" id="fnref:7" href="#fn:7"><sup>7</sup></a> </p> <h2 id="messaging-providers">Messaging Providers</h2> <p>A messaging provider keeps track of messages and routes them to the correct destination or destinations. It is a service that handles the transmission and routing of messages.<a class="footnote-ref" id="fnref:8" href="#fn:8"><sup>8</sup></a> </p> <h3>When to use a Messaging Provider</h3> <p>A JAXM client may or may not use a messaging provider. Generally, you do not need a messaging provider if you just want to be a consumer of Web services. Some limitations of not using a messaging provider are the following: </p><p>The client can send only request-response messages The client can act in the client role only </p><p>Some advantages to not using a messaging provider are the following: </p> <ul><li>The application can be written using the J2SE platform</li> <li>The application is not required to be deployed in a servlet container or a J2EE container</li> <li>No configuration is required<a class="footnote-ref" id="fnref:9" href="#fn:9"><sup>9</sup></a></li></ul> <h2 id="see-also">See also</h2> <ul><li><a href="http://jcp.org/en/jsr/detail?id=67">JSR 67: Java(TM) APIs for XML Messaging</a></li> <li><a href="http://download.oracle.com/otndocs/jcp/7902-jaxm-1.1-spec-oth-JSpec/">Java API for XML Messaging (JAXM) Specification 1.1</a></li> <li><a href="http://download.oracle.com/otndocs/jcp/jaxm-1.3-mrel-spec-oth-JSpec/">SOAP with Attachments API for Java (SAAJ) Specification 1.3</a></li> <li><a href="https://mq.java.net/nonav/javadoc/5.0/javadoc/index.html?javax/xml/messaging/package-summary.html">javax.xml.messaging</a> - this package is specified in the JAXM 1.1 specification</li> <li><a href="http://docs.oracle.com/javaee/7/api/index.html?javax/xml/soap/package-summary.html">javax.xml.soap</a> - this package is specified in the SAAJ 1.3 specification</li> <li><a href="http://www.tecnun.es/asignaturas/InteInfo/Recursos/Xml/docs/tutorial/doc/JAXM3.html#63936">Overview of JAXM</a> <a href="https://web.archive.org/web/20170510093344/http://www4.tecnun.es/asignaturas/InteInfo/Recursos/Xml/docs/tutorial/doc/JAXM3.html#63936">Archived</a> 2017-05-10 at the <a href="/facts/Wayback_Machine/nmQ3a6JC">Wayback Machine</a></li> <li><a href="http://www.java2s.com/Code/Java/J2EE/ThisexampledemonstratesahelloworldexampleforusingJAXMAPI.htm">Hello World Example for JAXM</a></li></ul> <h2 id="references">References</h2> <ol> <li id="fn:1"><p>"Java API for XML Messaging". <a href="http://www.inf.fu-berlin.de/lehre/SS03/19560-P/Docs/JWSDP/tutorial/doc/JAXM.html" target="_blank">http://www.inf.fu-berlin.de/lehre/SS03/19560-P/Docs/JWSDP/tutorial/doc/JAXM.html</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></p></li> <li id="fn:2"><p>"Java API for XML Messaging". <a href="http://www.inf.fu-berlin.de/lehre/SS03/19560-P/Docs/JWSDP/tutorial/doc/JAXM.html" target="_blank">http://www.inf.fu-berlin.de/lehre/SS03/19560-P/Docs/JWSDP/tutorial/doc/JAXM.html</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></p></li> <li id="fn:3"><p>"The Java(tm) XML Pack". Archived from the original on 2017-05-10. Retrieved 2013-02-05. <a href="https://web.archive.org/web/20170510093344/http://www4.tecnun.es/asignaturas/InteInfo/Recursos/Xml/docs/tutorial/doc/JAXM3.html#63936" target="_blank">https://web.archive.org/web/20170510093344/http://www4.tecnun.es/asignaturas/InteInfo/Recursos/Xml/docs/tutorial/doc/JAXM3.html#63936</a> <a href="#fnref:3" class="footnote-back-ref">↩</a></p></li> <li id="fn:4"><p>"The Java(tm) XML Pack". Archived from the original on 2017-05-10. Retrieved 2013-02-05. <a href="https://web.archive.org/web/20170510093344/http://www4.tecnun.es/asignaturas/InteInfo/Recursos/Xml/docs/tutorial/doc/JAXM3.html#63936" target="_blank">https://web.archive.org/web/20170510093344/http://www4.tecnun.es/asignaturas/InteInfo/Recursos/Xml/docs/tutorial/doc/JAXM3.html#63936</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></p></li> <li id="fn:5"><p>"SOAPConnection (Java EE 5 SDK)". <a href="http://docs.oracle.com/javaee/5/api/javax/xml/soap/SOAPConnection.html" target="_blank">http://docs.oracle.com/javaee/5/api/javax/xml/soap/SOAPConnection.html</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></p></li> <li id="fn:6"><p>"Overview of JAXM". <a href="http://docs.oracle.com/javaee/1.3/tutorial/doc/JAXM3.html" target="_blank">http://docs.oracle.com/javaee/1.3/tutorial/doc/JAXM3.html</a> <a href="#fnref:6" class="footnote-back-ref">↩</a></p></li> <li id="fn:7"><p>"Overview of JAXM". <a href="http://docs.oracle.com/javaee/1.3/tutorial/doc/JAXM3.html" target="_blank">http://docs.oracle.com/javaee/1.3/tutorial/doc/JAXM3.html</a> <a href="#fnref:7" class="footnote-back-ref">↩</a></p></li> <li id="fn:8"><p>"The Java(tm) XML Pack". Archived from the original on 2017-05-10. Retrieved 2013-02-05. <a href="https://web.archive.org/web/20170510093344/http://www4.tecnun.es/asignaturas/InteInfo/Recursos/Xml/docs/tutorial/doc/JAXM3.html#63936" target="_blank">https://web.archive.org/web/20170510093344/http://www4.tecnun.es/asignaturas/InteInfo/Recursos/Xml/docs/tutorial/doc/JAXM3.html#63936</a> <a href="#fnref:8" class="footnote-back-ref">↩</a></p></li> <li id="fn:9"><p>"Overview of JAXM". <a href="http://www.inf.fu-berlin.de/lehre/SS03/19560-P/Docs/JWSDP/tutorial/doc/JAXM2.html#63942" target="_blank">http://www.inf.fu-berlin.de/lehre/SS03/19560-P/Docs/JWSDP/tutorial/doc/JAXM2.html#63942</a> <a href="#fnref:9" class="footnote-back-ref">↩</a></p></li> </ol>