| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
| <!-- Generated by Apache Maven Doxia Site Renderer 1.3 at Jun 28, 2015 -->
|
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
| <head>
|
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
| <title>Apache Axis2 - |
| |
| |
| Apache Axis2 User's Guide- Introduction to Services</title>
|
| <style type="text/css" media="all">
|
| @import url("../css/maven-base.css");
|
| @import url("../css/maven-theme.css");
|
| @import url("../css/site.css");
|
| </style>
|
| <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
|
| <meta name="Date-Revision-yyyymmdd" content="20150628" />
|
| <meta http-equiv="Content-Language" content="en" />
|
| <meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" /><meta http-equiv="content-type" content="" />
|
| </head>
|
| <body class="composite">
|
| <div id="banner">
|
| <a href="http://www.apache.org/" id="bannerLeft">
|
| <img src="http://www.apache.org/images/asf_logo_wide.png" alt="Apache Axis2" />
|
| </a>
|
| <a href=".././" id="bannerRight">
|
| <img src="../images/axis.jpg" alt="Apache Axis2" />
|
| </a>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| <div id="breadcrumbs">
|
|
|
|
|
| <div class="xleft">
|
| <span id="publishDate">Last Published: 2015-06-28</span>
|
| | <span id="projectVersion">Version: 1.6.3</span>
|
| </div>
|
| <div class="xright"> <a href="../index.html" title="Axis2/Java">Axis2/Java</a>
|
| |
|
| <a href="http://www.apache.org" class="externalLink" title="Apache">Apache</a>
|
|
|
|
|
| </div>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| <div id="leftColumn">
|
| <div id="navcolumn">
|
|
|
|
|
| <h5>Axis2/Java</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../index.html" title="Home">Home</a>
|
| </li>
|
| </ul>
|
| <h5>Downloads</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../download.cgi" title="Releases">Releases</a>
|
| </li>
|
| <li class="none">
|
| <a href="../modules/index.html" title="Modules">Modules</a>
|
| </li>
|
| <li class="none">
|
| <a href="../tools/index.html" title="Tools">Tools</a>
|
| </li>
|
| </ul>
|
| <h5>Documentation</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../docs/toc.html" title="Table of Contents">Table of Contents</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/installationguide.html" title="Installation Guide">Installation Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/quickstartguide.html" title="QuickStart Guide">QuickStart Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/userguide.html" title="User Guide">User Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/jaxws-guide.html" title="JAXWS Guide">JAXWS Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/pojoguide.html" title="POJO Guide">POJO Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/spring.html" title="Spring Guide">Spring Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/webadminguide.html" title="Web Administrator's Guide">Web Administrator's Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/migration.html" title="Migration Guide (from Axis1)">Migration Guide (from Axis1)</a>
|
| </li>
|
| </ul>
|
| <h5>Resources</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../faq.html" title="FAQ">FAQ</a>
|
| </li>
|
| <li class="none">
|
| <a href="../articles.html" title="Articles">Articles</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="Wiki">Wiki</a>
|
| </li>
|
| <li class="none">
|
| <a href="../refLib.html" title="Reference Library">Reference Library</a>
|
| </li>
|
| <li class="none">
|
| <a href="../api/index.html" title="Online Java Docs">Online Java Docs</a>
|
| </li>
|
| </ul>
|
| <h5>Get Involved</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../overview.html" title="Overview">Overview</a>
|
| </li>
|
| <li class="none">
|
| <a href="../svn.html" title="Checkout the Source">Checkout the Source</a>
|
| </li>
|
| <li class="none">
|
| <a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
|
| </li>
|
| <li class="none">
|
| <a href="../release-process.html" title="Release Process">Release Process</a>
|
| </li>
|
| <li class="none">
|
| <a href="../guidelines.html" title="Developer Guidelines">Developer Guidelines</a>
|
| </li>
|
| <li class="none">
|
| <a href="../siteHowTo.html" title="Build the Site">Build the Site</a>
|
| </li>
|
| </ul>
|
| <h5>Project Information</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../team-list.html" title="Project Team">Project Team</a>
|
| </li>
|
| <li class="none">
|
| <a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/" class="externalLink" title="Source Code">Source Code</a>
|
| </li>
|
| <li class="none">
|
| <a href="../thanks.html" title="Acknowledgements">Acknowledgements</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="License">License</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">Sponsorship</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/security/" class="externalLink" title="Security">Security</a>
|
| </li>
|
| </ul>
|
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
|
| <img class="poweredBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
|
| </a>
|
|
|
|
|
| </div>
|
| </div>
|
| <div id="bodyColumn">
|
| <div id="contentBox">
|
| <!-- ~ Licensed to the Apache Software Foundation (ASF) under one |
| ~ or more contributor license agreements. See the NOTICE file |
| ~ distributed with this work for additional information |
| ~ regarding copyright ownership. The ASF licenses this file |
| ~ to you under the Apache License, Version 2.0 (the |
| ~ "License"); you may not use this file except in compliance |
| ~ with the License. You may obtain a copy of the License at |
| ~ |
| ~ http://www.apache.org/licenses/LICENSE-2.0 |
| ~ |
| ~ Unless required by applicable law or agreed to in writing, |
| ~ software distributed under the License is distributed on an |
| ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| ~ KIND, either express or implied. See the License for the |
| ~ specific language governing permissions and limitations |
| ~ under the License. --><html lang="en" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| |
| <a name="introservices" id="introservices"></a> |
| <h1>Apache Axis2 User's Guide - Introduction to Services</h1> |
| <p>The term "Web services" can apply to a number of different ways |
| of sending information back and forth. However, this guide focuses |
| on the sending and receiving of SOAP messages. SOAP messages are |
| XML documents that consist of an "envelope" containing a "payload" |
| (see Code Listing 4).</p> |
| <div class="section"><h2>Content<a name="Content"></a></h2> |
| <ul> |
| <li><a href="userguide.html#intro">Introducing Axis2</a><br /> |
| <ul> |
| <li><a href="userguide.html#whatis">What is Axis2?</a></li> |
| <li><a href="userguide.html#underhood">What's under the |
| hood?</a></li> |
| <li><a href="userguide.html#handlessoap">How Axis2 handles SOAP |
| messages</a></li> |
| <li><a href="userguide.html#distributions">Axis2 |
| distributions</a></li> |
| <li><a href="userguide.html#sbd">The Axis2 Standard Binary |
| Distribution</a></li> |
| <li><a href="userguide.html#hierarchy">Axis2.war Directory |
| Hierarchy</a></li> |
| <li><a href="userguide.html#docs">Axis2 Documents |
| Distribution</a></li> |
| <li><a href="userguide.html#clients">Axis2 and clients</a></li> |
| </ul> |
| </li> |
| <li><a href="userguide-installingtesting.html#installingtesting">Installing and |
| testing client code</a></li> |
| <li><a href="userguide-introtoservices.html#introservices"><b>Introduction |
| to Services</b></a><br /> |
| <ul> |
| <li><a href="userguide-introtoservices.html#messageexchange"><b>Message |
| Exchange Patterns</b></a></li> |
| </ul> |
| </li> |
| <li><a href="userguide-creatingclients.html#createclients">Creating |
| Clients</a><br /> |
| <ul> |
| <li><a href="userguide-creatingclients.html#choosingclient">Choosing a Client |
| Generation Method</a></li> |
| <li><a href="userguide-creatingclients.html#generating">Generating |
| Clients</a></li> |
| <li><a href="userguide-creatingclients.html#adb">Axis Data Binding |
| (ADB)</a></li> |
| </ul> |
| </li> |
| <li><a href="userguide-buildingservices.html#buildservices">Building |
| Services</a><br /> |
| <ul> |
| <li><a href="userguide-buildingservices.html#getcomfortable">Getting |
| Comfortable with the Available Options</a></li> |
| <li><a href="userguide-buildingservices.html#createscratch">Creating a service |
| from scratch</a></li> |
| <li><a href="userguide-buildingservices.html#deploypojo">Deploying |
| Plain Old Java Objects</a></li> |
| <li><a href="userguide-buildingservices.html#deployrun">Deploying |
| and running an Axis2 service created from WSDL</a></li> |
| </ul> |
| </li> |
| <li><a href="userguide-samples.html">Samples</a></li> |
| <li><a href="userguide-forfurtherstudy.html">For Further |
| Study</a></li> |
| </ul> |
| <div class="section"><h3>Code Listing 4: Example SOAP Message<a name="Code_Listing_4:_Example_SOAP_Message"></a></h3> |
| <div><pre> |
| <?xml version='1.0' ?> |
| <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" |
| xmlns:wsa="http://www.w3.org/2005/03/addressing"> |
| <env:Header> |
| |
| <wsa:MessageID> |
| http://ws.apache.org/9C21DE32-DB42-1228-C42E-66CB101421AD |
| </wsa:MessageID> |
| <wsa:ReplyTo> |
| <wsa:Address>http://example.com/projects/clientApp</wsa:Address> |
| </wsa:ReplyTo> |
| |
| <wsa:To>http://example.com/axis2/publishingService</wsa:To> |
| |
| <wsa:Action>http://example.com/axis2/addDocument</wsa:Action> |
| |
| </env:Header> |
| <env:Body> |
| |
| <addDocument> |
| <docTitle>What I Did On My Summer Vacation</doctitle> |
| <docSubtitle>Children's Essays from Accross the World</docSubtitle> |
| <docLocation>contentRepos/summerVac.doc</docLocation> |
| </addDocument> |
| |
| </env:Body> |
| </env:Envelope> |
| </pre></div> |
| <p>This XML document consists of the outer element or the SOAP |
| Envelope, and its contents. The SOAP Envelope is in the SOAP |
| namespace, http://www.w3.org/2003/05/soap-envelope, prefixed as |
| env: and contains up to two children. This envelope is a standard |
| format that pertains to every single SOAP message sent and received |
| by any SOAP Web service.</p> |
| <p>The contents of the Envelope consists of two parts; the first |
| being the SOAP headers-the contents of the env:Header element. |
| These headers, such as the WS-Addressing elements shown here, |
| provide additional information about the message and how it should |
| be handled. A SOAP message may carry headers relating to several |
| aspects of the message, or it may carry no headers at all. These |
| headers are typically processed by the message handlers.</p> |
| <p>The second and arguably the most important part of the message |
| is the payload, which consists of the contents of the env:Body |
| element. This is the actual message intended for the receiver, and |
| it is the information that the main application will ultimately |
| process.</p> |
| <a name="messageexchange" id="messageexchange"></a> |
| </div><div class="section"><h2>Message Exchange Patterns<a name="Message_Exchange_Patterns"></a></h2> |
| <p>Although all SOAP messages carry the same structure, the ways in |
| which they are used can be combined into a number of different |
| "message exchange patterns", or MEPs. The two major message |
| exchange patterns are:</p> |
| <ul> |
| <li>In-Out: in this MEP, the client sends a SOAP message to the |
| server, which processes the message and sends a response back. This |
| is probably the most commonly used MEP, and is useful for tasks |
| such as searching for information or submitting information in |
| situations in where acknowledgment is important.</li> |
| <li>In-Only: In this MEP, the client sends a message to the server |
| without expecting a response. You may use this MEP for activities |
| such as pinging a server to wake it up, reporting logging |
| information for which you do not need an acknowledgment and so |
| on.</li> |
| </ul> |
| <p>Within these two MEPs, you also have several variables to |
| consider:</p> |
| <ul> |
| <li>Blocking versus non-blocking: When the client sends a message, |
| the application may wait to receive a response before moving on, or |
| it may simply send a message and move on by specifying a callback |
| action to be completed when the response is received.</li> |
| <li>Number of parameters: Ultimately, a message sent from a client |
| to server is intended to execute a particular action. That action |
| may not require any parameters, or it may require one or more |
| parameters. These parameters must be encoded as part of the payload |
| of the message.</li> |
| </ul> |
| <p>Taking all these options into consideration, you can create |
| virtually any MEP. For example, you can create an Out-Only system |
| by reversing roles for the In-Only MEP. Apache Axis2 also includes |
| support for less prominent MEPs, such as Robust-In-Only.</p> |
| <p><b>See Next Section</b> - <a href="userguide-creatingclients.html#createclients">Creating |
| Clients</a></p> |
| |
| </html>
|
| </div>
|
| </div>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| <div id="footer">
|
| <div class="xright">
|
| Copyright © 2004-2015
|
| <a href="http://www.apache.org/">The Apache Software Foundation</a>.
|
| All Rights Reserved.
|
|
|
| </div>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| </body>
|
| </html>
|