| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/docs/xmlbased-server.xml at 2025-03-05 |
| | Rendered using Apache Maven Fluido Skin 2.0.0-M11 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>Writing Web Services Using Axis2's Primary APIs – Apache Axis2</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M11.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| <script src="../js/apache-maven-fluido-2.0.0-M11.min.js"></script> |
| <meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" /><meta http-equiv="content-type" content="" /> </head> |
| <body> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href="http://www.apache.org/"><img class="class java.lang.Object" src="http://www.apache.org/images/asf_logo_wide.png" /> Apache Axis2</a></h1></div></div> |
| <div class="pull-right"><div id="bannerRight"><h1><a href=".././"><img class="class java.lang.Object" src="../images/axis.jpg" /></a></h1></div></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2025-03-04<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 2.0.0<span class="divider">|</span></li> |
| <li><a href="http://www.apache.org" class="externalLink">Apache</a><span class="divider">/</span></li> |
| <li><a href="../index.html">Axis2/Java</a><span class="divider">/</span></li> |
| <li class="active">Writing Web Services Using Axis2's Primary APIs</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Axis2/Java</li> |
| <li><a href="../index.html">Home</a></li> |
| <li><a href="../download.html">Downloads</a></li> |
| <li><a href="javascript:void(0)"><span class="icon-chevron-down"></span>Release Notes</a> |
| <ul class="nav nav-list"> |
| <li><a href="../release-notes/1.6.1.html">1.6.1</a></li> |
| <li><a href="../release-notes/1.6.2.html">1.6.2</a></li> |
| <li><a href="../release-notes/1.6.3.html">1.6.3</a></li> |
| <li><a href="../release-notes/1.6.4.html">1.6.4</a></li> |
| <li><a href="../release-notes/1.7.0.html">1.7.0</a></li> |
| <li><a href="../release-notes/1.7.1.html">1.7.1</a></li> |
| <li><a href="../release-notes/1.7.2.html">1.7.2</a></li> |
| <li><a href="../release-notes/1.7.3.html">1.7.3</a></li> |
| <li><a href="../release-notes/1.7.4.html">1.7.4</a></li> |
| <li><a href="../release-notes/1.7.5.html">1.7.5</a></li> |
| <li><a href="../release-notes/1.7.6.html">1.7.6</a></li> |
| <li><a href="../release-notes/1.7.7.html">1.7.7</a></li> |
| <li><a href="../release-notes/1.7.8.html">1.7.8</a></li> |
| <li><a href="../release-notes/1.7.9.html">1.7.9</a></li> |
| <li><a href="../release-notes/1.8.0.html">1.8.0</a></li> |
| <li><a href="../release-notes/1.8.1.html">1.8.1</a></li> |
| <li><a href="../release-notes/1.8.2.html">1.8.2</a></li> |
| <li><a href="../release-notes/2.0.0.html">2.0.0</a></li> |
| </ul></li> |
| <li><a href="../modules/index.html">Modules</a></li> |
| <li><a href="../tools/index.html">Tools</a></li> |
| <li class="nav-header">Documentation</li> |
| <li><a href="../docs/toc.html">Table of Contents</a></li> |
| <li><a href="../docs/installationguide.html">Installation Guide</a></li> |
| <li><a href="../docs/quickstartguide.html">QuickStart Guide</a></li> |
| <li><a href="../docs/userguide.html">User Guide</a></li> |
| <li><a href="../docs/jaxws-guide.html">JAXWS Guide</a></li> |
| <li><a href="../docs/pojoguide.html">POJO Guide</a></li> |
| <li><a href="../docs/spring.html">Spring Guide</a></li> |
| <li><a href="../docs/webadminguide.html">Web Administrator's Guide</a></li> |
| <li><a href="../docs/migration.html">Migration Guide (from Axis1)</a></li> |
| <li class="nav-header">Resources</li> |
| <li><a href="../faq.html">FAQ</a></li> |
| <li><a href="../articles.html">Articles</a></li> |
| <li><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a></li> |
| <li><a href="../refLib.html">Reference Library</a></li> |
| <li><a href="../apidocs/index.html">Online Java Docs</a></li> |
| <li class="nav-header">Get Involved</li> |
| <li><a href="../overview.html">Overview</a></li> |
| <li><a href="../git.html">Checkout the Source</a></li> |
| <li><a href="../mail-lists.html">Mailing Lists</a></li> |
| <li><a href="../release-process.html">Release Process</a></li> |
| <li><a href="../guidelines.html">Developer Guidelines</a></li> |
| <li><a href="../siteHowTo.html">Build the Site</a></li> |
| <li class="nav-header">Project Information</li> |
| <li><a href="../team-list.html">Project Team</a></li> |
| <li><a href="../issue-tracking.html">Issue Tracking</a></li> |
| <li><a href="https://github.com/apache/axis-axis2-java-core" class="externalLink">Source Code</a></li> |
| <li><a href="../thanks.html">Acknowledgements</a></li> |
| <li class="nav-header">Apache</li> |
| <li><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a></li> |
| <li><a href="http://www.apache.org/security/" class="externalLink">Security</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| |
| <a id="Writing_Web_Services_Using Axis2's_Primary_APIs"></a> |
| <section><a id="Writing_Web_Services_Using_Apache_Axis2.27s_Primary_APIs"></a> |
| <h1>Writing Web Services Using Apache Axis2's Primary APIs</h1> |
| |
| <p>Apache Axis2 dispatches a component called |
| <strong>MessageReceiver</strong> when Receiving a Message to the |
| server. Apache Axis2 provides different implementations of this |
| class and it can be configured by adding a messageReceiver tag to |
| services.xml. Apache Axis2 provides an implementation for a class |
| of Message receivers called RawXml Message receivers. They work at |
| the XML level and can only handle OMElements as parameters. This |
| section explains how to write a service using them.</p> |
| |
| <p>In our example, the Web service will have two operations.</p> |
| |
| <pre> |
| public void ping(OMElement element){} //IN-ONLY operation, just accepts the OMElement and does some processing. |
| public OMElement echo(OMElement element){}//IN-OUT operation, accepts an OMElement and |
| // sends back the same again |
| </pre> |
| <a id="How_to_write_the_Web_Service_"></a> |
| <section><section><section><a id="How_to_Write_a_Web_Service.3F"></a> |
| <h4>How to Write a Web Service?</h4> |
| Writing a new Web service with Apache Axis2 involves four steps: |
| |
| <ol style="list-style-type: decimal;"> |
| |
| <li>Write the Implementation Class.</li> |
| |
| <li>Write a services.xml file to explain the Web service.</li> |
| |
| <li>Create a *.aar archive (Axis Archive) for the Web service.</li> |
| |
| <li>Deploy the Web service.</li> |
| </ol> |
| <a id="Step1_:Write_the_Implementation_Class"></a> |
| </section><section><a id="Step1.3A_Write_the_Implementation_Class"></a> |
| <h4>Step1: Write the Implementation Class</h4> |
| |
| <p>An implementation class has the business logic for the Web |
| service and implements the operations provided by the Web service. |
| Unless you have data binding, the signature of the methods can have |
| only one parameter of the type OMElement. <i>OM stands for Object |
| Model (also known as AXIOM - AXis Object Model) and refers to the |
| XML infoset model that is initially developed for Apache Axis2. DOM |
| and JDOM are two such XML models conceptually similar to OM as an |
| XML model by its external behavior, but considering the deep down |
| implementation OM is very much different to others. OMElement is |
| the basic representation of the XML infoset element in OM.For more |
| details on OMElement see the <a href="http://ws.apache.org/axiom/userguide/userguide.html" class="externalLink">Axiom |
| User Guide</a>.</i></p> |
| |
| <pre> |
| public class MyService{ |
| public void ping(OMElement element){ |
| // Business Logic |
| ...... |
| } |
| public OMElement echo(OMElement element){ |
| ...... |
| } |
| } |
| </pre> |
| <a id="Step2_:Write_the_services_xml_file"></a> |
| </section><section><a id="Step2.3A_Write_the_services.xml_file"></a> |
| <h4>Step2: Write the services.xml file</h4> |
| |
| <p>"services.xml" has the configuration for a Web service. Each Web |
| service, deployed in Apache Axis2 , must have its configuration in |
| "services.xml". The configuration for MyService is as follows:</p> |
| |
| <pre> |
| <service > |
| <description> |
| This is a sample Web service with two operations, echo and ping. |
| </description> |
| <parameter name="ServiceClass">userguide.example1.MyService</parameter> |
| <operation name="echo"> |
| <messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/> |
| <actionMapping>urn:echo</actionMapping> |
| </operation> |
| <operation name="ping"> |
| <messageReceiver class="org.apache.axis2.receivers.RawXMLINOnlyMessageReceiver"/> |
| <actionMapping>urn:ping</actionMapping> |
| </operation> |
| </service> |
| </pre> |
| |
| <p>The above XML tags can be explained as follows:</p> |
| |
| <p>1. The description of the service class is provided in the |
| description tag.</p> |
| |
| <pre> |
| <service > |
| <description> |
| This is a sample Web service with two operations, echo and ping. |
| </description> |
| </pre> |
| |
| <p>2. The name of the service class is provided as a parameter.</p> |
| |
| <pre> |
| <parameter name="serviceClass">userguide.example1.MyService</parameter> |
| </pre> |
| |
| <p>3. The "operation" XML tag describes the operations that are |
| available in this service with respective message receivers.</p> |
| |
| <pre> |
| <operation name="echo"> |
| <messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/> |
| <actionMapping>urn:echo</actionMapping> |
| </operation> |
| <operation name="ping"> |
| <messageReceiver class="org.apache.axis2.receivers.RawXMLINOnlyMessageReceiver"/> |
| <actionMapping>urn:ping</actionMapping> |
| </operation> |
| </pre> |
| |
| <p>4. Every operation must map to a corresponding MessageReceiver |
| class. After a message is processed by the handlers, the Axis2 |
| engine hands it over to a MessageReceiver.</p> |
| |
| <p>5. For the "echo" operation, we have used a |
| <strong>RawXMLINOutMessageReceiver</strong> since it is an IN-OUT |
| operation. For the IN-ONLY operation "ping", we have used |
| <strong>RawXMLINOnlyMessageReceiver</strong> as the message |
| receiver.</p> |
| |
| <p>6. The actionMapping is required only if you want to enable |
| WS-Addressing. This will be used later in this user guide.</p> |
| |
| <p>7. You can write a services.xml file to include a group of |
| services instead of a single service. This makes the management and |
| deployment of a set of related services very easy. At runtime, you |
| can share information between these services within a single |
| interaction using the ServiceGroupContext. If you hope to use this |
| functionality, the services.xml file should have the following |
| format.</p> |
| |
| <pre> |
| <ServiceGroup> |
| <service name="Service1"> |
| <!-- details for Service1 --> |
| </service> |
| <service name="Service2"> |
| <!-- details for Service2 --> |
| </service> |
| <module ref="ModuleName" /> |
| <parameter name="serviceGroupParam1">value 1</parameter> |
| </serviceGroup> |
| </pre> |
| |
| <p>Note : The name of the service is a compulsory attribute.</p> |
| <a id="Step3_:Create_the_Web_Service_Archive"></a> |
| </section><section><a id="Step3.3A_Create_the_Web_Service_Archive"></a> |
| <h4>Step3: Create the Web Service Archive</h4> |
| |
| <p>Apache Axis2 uses the ".aar" (Axis Archive) file as the |
| deployment package for Web services. Therefore, for MyService we |
| will use "MyService.aar" with the "services.xml" packaged in the |
| META-INF in the directory structure shown below. Please note that |
| the name of the archive file will be the same as that of the |
| service only if the services.xml contains only one service |
| element.</p> |
| |
| <p><img src="images/userguide/ServiceItems.jpg" width="176" height="91" id="Graphic1" /></p> |
| |
| <p>To create the archive file, you can create a .jar file |
| containing all the necessary files and then rename it to a .aar |
| file. This archive file can be found in the |
| "Axis2_HOME/samples/userguide" directory. This file has to be |
| deployed now.</p> |
| <a id="Step4_:Deploy_the_Web_Service"></a> |
| </section><section><a id="Step4.3A_Deploy_the_Web_Service"></a> |
| <h4>Step4: Deploy the Web Service</h4> |
| |
| <p>The service can be deployed by dropping the ".aar" file into the |
| "services" directory in "/webapps/axis2/WEB-INF" of your servlet |
| container. Start the servlet container (if you have not already |
| started), click the link "Services" on the <a href="http://localhost:8080/axis2/" class="externalLink">Home Page of Axis2 |
| Web Application</a> (http://localhost:8080/axis2) and see whether |
| MyService is deployed properly. If you can see the following |
| output, then you have successfully deployed MyService on Apache |
| Axis2. Congratulations !!</p> |
| |
| <p><img src="images/userguide/MyServiceDeployed.jpg" id="Graphic2" /></p> |
| |
| <p>Note: Apache Axis2 provides an easy way to deploy Web services |
| using the "Upload Service" tool on the Axis2 Web Application's |
| Administration module. Please refer to the <a href="webadminguide.html">Web Administration Guide</a> |
| for more information.</p> |
| </section></section></section> |
| </html> </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2004–2025 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
