axis2/java/core/docs/spring.html - axis-site - Git at Google

 <!DOCTYPE html>


 <!--
  | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/docs/spring.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>Axis2 integration with the Spring Framework – 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 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">Axis2 integration with the Spring Framework</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 class="active"><a>Spring Guide</a></li>
     <li><a href="../docs/webadminguide.html">Web Administrator&apos;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>

 <section><a id="Axis2_Integration_with_the_Spring_Framework"></a>
 <h1>Axis2 Integration with the Spring Framework</h1>


 <p>This document is a guide on how to use Axis2 with the Spring Framework</p>


 <p>
 For users of JSON and <a href="https://spring.io/projects/spring-boot" class="externalLink">Spring Boot</a>
 - or anyone interesed in a complete Spring Boot example that includes Spring Security -
 see the sample application in the <a href="json-springboot-userguide.html">JSON and Spring Boot User's Guide.</a>
 </p>


 <p>
 Update: Spring inside the AAR is no longer supported. See this commit:
 </p>


 <pre>
 commit 9e392c0ae1f0abab3d4956fbf4c0818c9570021e
 Author: Andreas Veithen &lt;veithen@apache.org&gt;
 Date:   Sat May 6 22:21:10 2017 +0000

     AXIS2-3919: Remove the alternate class loading mechanism:
     - It degrades performance.
     - There is no test coverage for it.
     - With r1794157 in place, in most cases, no temporary files will be created and there is no need for a fallback mechanism.
 </pre>

 <section><a id="Content"></a>
 <h2>Content</h2>

 <ul>

 <li><a href="#a1">Introduction</a></li>

 <li><a href="#a2">Configuring Axis2 to be Spring Aware</a>

 <ul>

 <li><a href="#a21">Programming Model</a></li>

 <li><a href="#a22">Simple Spring Config Example</a></li>

 <li><a href="#a23">With a ServletContext</a></li>

 <li><a href="#a24">Without a ServletContext</a></li>

 <li><a href="#a25">Putting it All Together</a></li>
     </ul>
   </li>
 </ul>
 <a id="1"></a>

 </section><section><a id="Introduction"></a>
 <h2>Introduction</h2>


 <p>Axis2 and Spring integration takes place when Spring supplies one of its
 pre-loaded beans to the Axis2 Message Receiver defined in the AAR
 services.xml. Axis2 typically uses reflection to instantiate the ServiceClass
 defined in the services.xml used by the Message Receiver. Alternatively, you
 can define a ServiceObjectSupplier that will supply the Object.</p>


 <p>This guide describes how to use two separate ServiceObjectSupplier classes
 that are a part of the Axis2 standard distribution - one for use with a
 ServletContext, and one without. Configuring Axis2 with a ServletContext is
 simpler than without, and is recommended for most use cases. Without a
 ServletContext, ie, Spring inside the AAR, requires an extra Spring bean
 and is considered an advanced use case. Once configured, the Web service itself
 acts like any other Spring wired bean. These Spring beans can be loaded any way
 desired as Axis2 has no configuration file dependencies from Spring. Spring
 versions 1.2.6, 1.2.8 and 2.0 have been tested, but probably any version
 would work as only the core functionality is required.</p>


 <p>This guide assumes some basic knowledge of Axis2. See the <a href="userguide.html">User's Guide</a> for more information.</p>
 <a id="2"></a>

 <section><a id="Programming_Model"></a>
 <h3>Programming Model</h3>


 <p>From an Axis2 standpoint, two hooks are needed to be placed into the AAR
 services.xml - the ServiceObjectSupplier that hooks Axis2 and Spring
 together, and the name of the Spring bean that Axis2 will use as the service.
 All Message Receivers are currently supported, as would be any Message
 Receiver that extends org.apache.axis2.receivers.AbstractMessageReceiver .</p>
 <a id="22"></a>

 </section><section><a id="Simple_Spring_Config_Example"></a>
 <h3>Simple Spring Config Example</h3>


 <p>For the purpose of this example, we'll configure Spring via a WAR file's
 web.xml. Let's add a context-param and a listener:</p>

 <pre>&lt;listener&gt;
         &lt;listener-class&gt;org.springframework.web.context.ContextLoaderListener&lt;/listener-class&gt;
 &lt;/listener&gt;
 &lt;context-param&gt;
       &lt;param-name&gt;contextConfigLocation&lt;/param-name&gt;
       &lt;param-value&gt;/WEB-INF/applicationContext.xml&lt;/param-value&gt;
 &lt;/context-param&gt;</pre>


 <p>Next we will show two examples of Spring's /WEB-INF/applicationContext.xml
 referenced in the web.xml listener -  one using a ServletContext, and one
 without.</p>
 <a id="23"></a>

 </section><section><a id="With_a_ServletContext"></a>
 <h3>With a ServletContext</h3>


 <p>This example (with a ServletContext) applicationContext.xml should be
 familiar to any Spring user:</p>

 <pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
 &lt;!DOCTYPE beans PUBLIC &quot;-//SPRING//DTD BEAN//EN&quot; &quot;http://www.springframework.org/dtd/spring-beans.dtd&quot;&gt;

 &lt;beans&gt;
   &lt;!-- Axis2 Web Service, but to Spring, its just another bean that has dependencies --&gt;
   &lt;bean id=&quot;springAwareService&quot; class=&quot;spring.SpringAwareService&quot;&gt;
     &lt;property name=&quot;myBean&quot; ref=&quot;myBean&quot;/&gt;
   &lt;/bean&gt;

   &lt;!-- just another bean / interface with a wired implementation, that's injected by Spring
           into the Web Service --&gt;
    &lt;bean id=&quot;myBean&quot; class=&quot;spring.MyBeanImpl&quot;&gt;
      &lt;property name=&quot;val&quot; value=&quot;Spring, emerge thyself&quot; /&gt;
   &lt;/bean&gt;
 &lt;/beans&gt;</pre>


 <p>If the service is running in a Servlet Container, i.e., Axis2 will be able
 to get a hold of the ServletContext, the services.xml for the example would
 be using SpringServletContextObjectSupplier such as:</p>

 <pre> &lt;service name=&quot;SpringAwareService&quot;&gt;
     &lt;description&gt;
         simple spring example
     &lt;/description&gt;
     &lt;parameter name=&quot;ServiceObjectSupplier&quot;&gt;org.apache.axis2.extensions.spring.receivers.SpringServletContextObjectSupplier&lt;/parameter&gt;
     &lt;parameter name=&quot;SpringBeanName&quot;&gt;springAwareService&lt;/parameter&gt;
     &lt;operation name=&quot;getValue&quot;&gt;
         &lt;messageReceiver class=&quot;org.apache.axis2.receivers.RawXMLINOutMessageReceiver&quot;/&gt;
     &lt;/operation&gt;
 &lt;/service&gt; </pre>


 <p>While the above example uses RawXMLINOutMessageReceiver as its
 messageReceiver class, all Message Receivers are currently supported, as
 would be any Message Receiver that extends
 org.apache.axis2.receivers.AbstractMessageReceiver .</p>
 <a id="24"></a>

 </section><section><a id="Without_a_ServletContext"></a>
 <h3>Without a ServletContext</h3>


 <p>In case Axis2 can't get a ServletContext, (i.e., uses a different
 transport or is running Axis2 inside the AAR etc,) you have the option of
 defining a bean that takes advantage of Spring's internal abilities
 (ApplicationContextAware interface, specifically) to provide an Application
 Context to Axis2, with a bean ref 'applicationContext' :</p>

 <pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
 &lt;!DOCTYPE beans PUBLIC &quot;-//SPRING//DTD BEAN//EN&quot; &quot;http://www.springframework.org/dtd/spring-beans.dtd&quot;&gt;

 &lt;beans&gt;
   &lt;!-- Configure spring to give a hook to axis2 without a ServletContext --&gt;
   &lt;bean id=&quot;applicationContext&quot;
     class=&quot;org.apache.axis2.extensions.spring.receivers.ApplicationContextHolder&quot; /&gt;

   &lt;!-- Axis2 Web Service, but to Spring, its just another bean that has dependencies --&gt;
   &lt;bean id=&quot;springAwareService&quot;
         class=&quot;spring.SpringAwareService&quot;&gt;
     &lt;property name=&quot;myBean&quot; ref=&quot;myBean&quot; /&gt;
   &lt;/bean&gt;

   &lt;!-- just another bean with a wired implementation, that's injected by Spring
           into the Web Service --&gt;
    &lt;bean id=&quot;myBean&quot;
         class=&quot;spring.MyBeanImpl&quot;&gt;
      &lt;property name=&quot;val&quot; value=&quot;Spring, emerge thyself&quot; /&gt;
   &lt;/bean&gt;
 &lt;/beans&gt;</pre>


 <p>If the service is <strong>not</strong> running in a Servlet Container,
 i.e., Axis2 will not be able to get a hold of ServletContext or you prefer
 not to, the services.xml for the example will be using
 SpringAppContextAwareObjectSupplier such as:</p>

 <pre> &lt;service name=&quot;SpringAwareService&quot;&gt;
     &lt;description&gt;
         simple spring example
     &lt;/description&gt;
     &lt;parameter name=&quot;ServiceObjectSupplier&quot;&gt;org.apache.axis2.extensions.spring.receivers.SpringAppContextAwareObjectSupplier&lt;/parameter&gt;
     &lt;parameter name=&quot;SpringBeanName&quot;&gt;springAwareService&lt;/parameter&gt;
     &lt;operation name=&quot;getValue&quot;&gt;
         &lt;messageReceiver class=&quot;org.apache.axis2.receivers.RawXMLINOutMessageReceiver&quot;/&gt;
     &lt;/operation&gt;
 &lt;/service&gt; </pre>


 <p>While the above example uses RawXMLINOutMessageReceiver as its
 messageReceiver class, all Message Receivers are currently supported, as
 would be any Message Receiver that extends
 org.apache.axis2.receivers.AbstractMessageReceiver .</p>


 <p>In an environment <strong>without a ServletContext</strong>, one way you
 could load the applicationContext.xml file is in a place that will be run
 once. Upon start-up, execute the following:</p>

 <pre>import org.springframework.context.support.ClassPathXmlApplicationContext;

  public void createSpringAppCtx(ClassLoader cl)
             throws Exception {

     ClassPathXmlApplicationContext ctx = new
       ClassPathXmlApplicationContext(new String[] {Constants.MY_PATH +
       &quot;spring/applicationContext.xml&quot;}, false);
            ctx.setClassLoader(cl);
            ctx.refresh();</pre>
 } <a id="25"></a>

 </section><section><a id="Putting_It_All_Together"></a>
 <h3>Putting It All Together</h3>


 <p>From here, it's just standard Axis2 coding. Only now the service has
 Spring wiring capabilities. The implementation is the same whether using
 either SpringServletContextObjectSupplier or
 SpringAppContextAwareObjectSupplier. The service is as follows:</p>

 <pre>package spring;

 import org.apache.axiom.om.OMAbstractFactory;
 import org.apache.axiom.om.OMElement;
 import org.apache.axiom.om.OMFactory;
 import org.apache.axiom.om.OMNamespace;
 import org.apache.axiom.om.OMText;

 public class SpringAwareService {

     private MyBean myBean = null;

     //spring 'injects' this implementation
     public void setMyBean(MyBean myBean) {
             this.myBean = myBean;
     }

     // The web service
     public OMElement getValue(OMElement ignore) {
             OMFactory factory=
                 OMAbstractFactory.getOMFactory();
             OMNamespace payloadNs= factory.createOMNamespace(
                 &quot;http://springExample.org/example1&quot;, &quot;example1&quot;);
             OMElement payload =
                 factory.createOMElement(&quot;string&quot;, payloadNs);
             OMText response = factory.createOMText(this.myBean.emerge());
             payload.addChild(response);
             return payload;
     }
 } </pre>


 <p>For those who are new to Spring, one of the ideas is that you program an
 Interface, as the implementation is pluggable. This idea is referenced in the
 Spring config file above. Below is the interface:</p>

 <pre>package spring;

 /** Interface for Spring aware Bean */
 public interface MyBean {
          String emerge();
 }</pre>


 <p>Here's the implementation:</p>

 <pre>/** Spring wired implementation */
 public class MyBeanImpl implements MyBean {

     String str = null;
     // spring 'injects' this value
     public void setVal(String s) {
         str = s;
     }
     // web service gets this value
     public String emerge() {
         return str;
     }
 }</pre>


 <p>Lastly here's the client - not really necessary for the example, other
 than for completeness:</p>

 <pre>package client;

 import java.io.StringWriter;

 import javax.xml.stream.XMLOutputFactory;

 import org.apache.axiom.om.OMAbstractFactory;
 import org.apache.axiom.om.OMElement;
 import org.apache.axiom.om.OMFactory;
 import org.apache.axiom.om.OMNamespace;
 import org.apache.axis2.addressing.EndpointReference;
 import org.apache.axis2.client.Options;
 import org.apache.axis2.client.ServiceClient;

 public class TestClient {
     private static EndpointReference targetEPR =
         new EndpointReference(
                &quot;http://localhost:8080/axis2/services/SpringAwareService&quot;);

     /**
      * Simple axis2 client.
      *
      * @param args Main
      */
     public static void main(String[] args) {
         try {
             OMFactory factory = OMAbstractFactory.getOMFactory();
             OMNamespace omNs = factory.createOMNamespace(
                         &quot;http://springExample.org/example1&quot;, &quot;example1&quot;);

             OMElement method = factory.createOMElement(&quot;getValue&quot;, omNs);
             OMElement value = factory.createOMElement(&quot;Text&quot;, omNs);
             value.addChild(factory.createOMText(value, &quot;Some String &quot;));
             method.addChild(value);

             ServiceClient serviceClient = new ServiceClient();

             Options options = new Options();
             serviceClient.setOptions(options);
             options.setTo(targetEPR);

             //Blocking invocation
             OMElement result = serviceClient.sendReceive(method);

             StringWriter writer = new StringWriter();
             result.serialize(XMLOutputFactory.newInstance()
                     .createXMLStreamWriter(writer));
             writer.flush();

             System.out.println(&quot;Response: &quot; + writer.toString());
         } catch (Exception ex) {
             ex.printStackTrace();
         }
     }
 } </pre>


 <p>The examples above assume that both the spring framework .jar and the
 axis2-spring-*.jar are under WEB-INF/lib. In such a case, the classes shown
 in this tutorial need to be placed in a JAR under WEB-INF/lib. In this
 example the JAR layout is:</p>

 <pre>./mySpring.jar
 ./META-INF
 ./META-INF/MANIFEST.MF
 ./spring
 ./spring/MyBean.class
 ./spring/MyBeanImpl.class
 ./spring/SpringAwareService.class</pre>

 <p>Since all the user classes are in mySpring.jar in this example, the AAR
 merely contains the services.xml file:</p>

 <pre>./springExample.aar
 ./META-INF
 ./META-INF/MANIFEST.MF
 ./META-INF/services.xml</pre>

 <p>To run this example, make sure you have the axis2-spring*.jar that comes
 from the axis2-std-*-bin distro in the server side WEB-INF/lib, as well as
 the appropriate Spring jar - most will use the full spring.jar, but the
 minimum requirements are spring-core, spring-beans, spring-context, and
 spring-web. When running the client, you should see this output:</p>

 <pre>Response: &lt;example1:string xmlns:example1=&quot;http://springExample.org/example1&quot;
   xmlns:tns=&quot;http://ws.apache.org/axis2&quot;&gt;Spring, emerge thyself&lt;/example1:string&gt;</pre>
 </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>
	<!DOCTYPE html>


	<!--
	\| Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/docs/spring.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>Axis2 integration with the Spring Framework – 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 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">Axis2 integration with the Spring Framework</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 class="active"><a>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>

	<section><a id="Axis2_Integration_with_the_Spring_Framework"></a>
	<h1>Axis2 Integration with the Spring Framework</h1>


	<p>This document is a guide on how to use Axis2 with the Spring Framework</p>


	<p>
	For users of JSON and <a href="https://spring.io/projects/spring-boot" class="externalLink">Spring Boot</a>
	- or anyone interesed in a complete Spring Boot example that includes Spring Security -
	see the sample application in the <a href="json-springboot-userguide.html">JSON and Spring Boot User's Guide.</a>
	</p>


	<p>
	Update: Spring inside the AAR is no longer supported. See this commit:
	</p>


	<pre>
	commit 9e392c0ae1f0abab3d4956fbf4c0818c9570021e
	Author: Andreas Veithen <veithen@apache.org>
	Date: Sat May 6 22:21:10 2017 +0000

	AXIS2-3919: Remove the alternate class loading mechanism:
	- It degrades performance.
	- There is no test coverage for it.
	- With r1794157 in place, in most cases, no temporary files will be created and there is no need for a fallback mechanism.
	</pre>

	<section><a id="Content"></a>
	<h2>Content</h2>

	<ul>

	<li><a href="#a1">Introduction</a></li>

	<li><a href="#a2">Configuring Axis2 to be Spring Aware</a>

	<ul>

	<li><a href="#a21">Programming Model</a></li>

	<li><a href="#a22">Simple Spring Config Example</a></li>

	<li><a href="#a23">With a ServletContext</a></li>

	<li><a href="#a24">Without a ServletContext</a></li>

	<li><a href="#a25">Putting it All Together</a></li>
	</ul>
	</li>
	</ul>
	<a id="1"></a>

	</section><section><a id="Introduction"></a>
	<h2>Introduction</h2>


	<p>Axis2 and Spring integration takes place when Spring supplies one of its
	pre-loaded beans to the Axis2 Message Receiver defined in the AAR
	services.xml. Axis2 typically uses reflection to instantiate the ServiceClass
	defined in the services.xml used by the Message Receiver. Alternatively, you
	can define a ServiceObjectSupplier that will supply the Object.</p>


	<p>This guide describes how to use two separate ServiceObjectSupplier classes
	that are a part of the Axis2 standard distribution - one for use with a
	ServletContext, and one without. Configuring Axis2 with a ServletContext is
	simpler than without, and is recommended for most use cases. Without a
	ServletContext, ie, Spring inside the AAR, requires an extra Spring bean
	and is considered an advanced use case. Once configured, the Web service itself
	acts like any other Spring wired bean. These Spring beans can be loaded any way
	desired as Axis2 has no configuration file dependencies from Spring. Spring
	versions 1.2.6, 1.2.8 and 2.0 have been tested, but probably any version
	would work as only the core functionality is required.</p>


	<p>This guide assumes some basic knowledge of Axis2. See the <a href="userguide.html">User's Guide</a> for more information.</p>
	<a id="2"></a>

	<section><a id="Programming_Model"></a>
	<h3>Programming Model</h3>


	<p>From an Axis2 standpoint, two hooks are needed to be placed into the AAR
	services.xml - the ServiceObjectSupplier that hooks Axis2 and Spring
	together, and the name of the Spring bean that Axis2 will use as the service.
	All Message Receivers are currently supported, as would be any Message
	Receiver that extends org.apache.axis2.receivers.AbstractMessageReceiver .</p>
	<a id="22"></a>

	</section><section><a id="Simple_Spring_Config_Example"></a>
	<h3>Simple Spring Config Example</h3>


	<p>For the purpose of this example, we'll configure Spring via a WAR file's
	web.xml. Let's add a context-param and a listener:</p>

	<pre><listener>
	<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>
	<context-param>
	<param-name>contextConfigLocation</param-name>
	<param-value>/WEB-INF/applicationContext.xml</param-value>
	</context-param></pre>


	<p>Next we will show two examples of Spring's /WEB-INF/applicationContext.xml
	referenced in the web.xml listener - one using a ServletContext, and one
	without.</p>
	<a id="23"></a>

	</section><section><a id="With_a_ServletContext"></a>
	<h3>With a ServletContext</h3>


	<p>This example (with a ServletContext) applicationContext.xml should be
	familiar to any Spring user:</p>

	<pre><?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">

	<beans>
	<!-- Axis2 Web Service, but to Spring, its just another bean that has dependencies -->
	<bean id="springAwareService" class="spring.SpringAwareService">
	<property name="myBean" ref="myBean"/>
	</bean>

	<!-- just another bean / interface with a wired implementation, that's injected by Spring
	into the Web Service -->
	<bean id="myBean" class="spring.MyBeanImpl">
	<property name="val" value="Spring, emerge thyself" />
	</bean>
	</beans></pre>


	<p>If the service is running in a Servlet Container, i.e., Axis2 will be able
	to get a hold of the ServletContext, the services.xml for the example would
	be using SpringServletContextObjectSupplier such as:</p>

	<pre> <service name="SpringAwareService">
	<description>
	simple spring example
	</description>
	<parameter name="ServiceObjectSupplier">org.apache.axis2.extensions.spring.receivers.SpringServletContextObjectSupplier</parameter>
	<parameter name="SpringBeanName">springAwareService</parameter>
	<operation name="getValue">
	<messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/>
	</operation>
	</service> </pre>


	<p>While the above example uses RawXMLINOutMessageReceiver as its
	messageReceiver class, all Message Receivers are currently supported, as
	would be any Message Receiver that extends
	org.apache.axis2.receivers.AbstractMessageReceiver .</p>
	<a id="24"></a>

	</section><section><a id="Without_a_ServletContext"></a>
	<h3>Without a ServletContext</h3>


	<p>In case Axis2 can't get a ServletContext, (i.e., uses a different
	transport or is running Axis2 inside the AAR etc,) you have the option of
	defining a bean that takes advantage of Spring's internal abilities
	(ApplicationContextAware interface, specifically) to provide an Application
	Context to Axis2, with a bean ref 'applicationContext' :</p>

	<pre><?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">

	<beans>
	<!-- Configure spring to give a hook to axis2 without a ServletContext -->
	<bean id="applicationContext"
	class="org.apache.axis2.extensions.spring.receivers.ApplicationContextHolder" />

	<!-- Axis2 Web Service, but to Spring, its just another bean that has dependencies -->
	<bean id="springAwareService"
	class="spring.SpringAwareService">
	<property name="myBean" ref="myBean" />
	</bean>

	<!-- just another bean with a wired implementation, that's injected by Spring
	into the Web Service -->
	<bean id="myBean"
	class="spring.MyBeanImpl">
	<property name="val" value="Spring, emerge thyself" />
	</bean>
	</beans></pre>


	<p>If the service is <strong>not</strong> running in a Servlet Container,
	i.e., Axis2 will not be able to get a hold of ServletContext or you prefer
	not to, the services.xml for the example will be using
	SpringAppContextAwareObjectSupplier such as:</p>

	<pre> <service name="SpringAwareService">
	<description>
	simple spring example
	</description>
	<parameter name="ServiceObjectSupplier">org.apache.axis2.extensions.spring.receivers.SpringAppContextAwareObjectSupplier</parameter>
	<parameter name="SpringBeanName">springAwareService</parameter>
	<operation name="getValue">
	<messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/>
	</operation>
	</service> </pre>


	<p>While the above example uses RawXMLINOutMessageReceiver as its
	messageReceiver class, all Message Receivers are currently supported, as
	would be any Message Receiver that extends
	org.apache.axis2.receivers.AbstractMessageReceiver .</p>


	<p>In an environment <strong>without a ServletContext</strong>, one way you
	could load the applicationContext.xml file is in a place that will be run
	once. Upon start-up, execute the following:</p>

	<pre>import org.springframework.context.support.ClassPathXmlApplicationContext;

	public void createSpringAppCtx(ClassLoader cl)
	throws Exception {

	ClassPathXmlApplicationContext ctx = new
	ClassPathXmlApplicationContext(new String[] {Constants.MY_PATH +
	"spring/applicationContext.xml"}, false);
	ctx.setClassLoader(cl);
	ctx.refresh();</pre>
	} <a id="25"></a>

	</section><section><a id="Putting_It_All_Together"></a>
	<h3>Putting It All Together</h3>


	<p>From here, it's just standard Axis2 coding. Only now the service has
	Spring wiring capabilities. The implementation is the same whether using
	either SpringServletContextObjectSupplier or
	SpringAppContextAwareObjectSupplier. The service is as follows:</p>

	<pre>package spring;

	import org.apache.axiom.om.OMAbstractFactory;
	import org.apache.axiom.om.OMElement;
	import org.apache.axiom.om.OMFactory;
	import org.apache.axiom.om.OMNamespace;
	import org.apache.axiom.om.OMText;

	public class SpringAwareService {

	private MyBean myBean = null;

	//spring 'injects' this implementation
	public void setMyBean(MyBean myBean) {
	this.myBean = myBean;
	}

	// The web service
	public OMElement getValue(OMElement ignore) {
	OMFactory factory=
	OMAbstractFactory.getOMFactory();
	OMNamespace payloadNs= factory.createOMNamespace(
	"http://springExample.org/example1", "example1");
	OMElement payload =
	factory.createOMElement("string", payloadNs);
	OMText response = factory.createOMText(this.myBean.emerge());
	payload.addChild(response);
	return payload;
	}
	} </pre>


	<p>For those who are new to Spring, one of the ideas is that you program an
	Interface, as the implementation is pluggable. This idea is referenced in the
	Spring config file above. Below is the interface:</p>

	<pre>package spring;

	/** Interface for Spring aware Bean */
	public interface MyBean {
	String emerge();
	}</pre>


	<p>Here's the implementation:</p>

	<pre>/** Spring wired implementation */
	public class MyBeanImpl implements MyBean {

	String str = null;
	// spring 'injects' this value
	public void setVal(String s) {
	str = s;
	}
	// web service gets this value
	public String emerge() {
	return str;
	}
	}</pre>


	<p>Lastly here's the client - not really necessary for the example, other
	than for completeness:</p>

	<pre>package client;

	import java.io.StringWriter;

	import javax.xml.stream.XMLOutputFactory;

	import org.apache.axiom.om.OMAbstractFactory;
	import org.apache.axiom.om.OMElement;
	import org.apache.axiom.om.OMFactory;
	import org.apache.axiom.om.OMNamespace;
	import org.apache.axis2.addressing.EndpointReference;
	import org.apache.axis2.client.Options;
	import org.apache.axis2.client.ServiceClient;

	public class TestClient {
	private static EndpointReference targetEPR =
	new EndpointReference(
	"http://localhost:8080/axis2/services/SpringAwareService");

	/**
	* Simple axis2 client.
	*
	* @param args Main
	*/
	public static void main(String[] args) {
	try {
	OMFactory factory = OMAbstractFactory.getOMFactory();
	OMNamespace omNs = factory.createOMNamespace(
	"http://springExample.org/example1", "example1");

	OMElement method = factory.createOMElement("getValue", omNs);
	OMElement value = factory.createOMElement("Text", omNs);
	value.addChild(factory.createOMText(value, "Some String "));
	method.addChild(value);

	ServiceClient serviceClient = new ServiceClient();

	Options options = new Options();
	serviceClient.setOptions(options);
	options.setTo(targetEPR);

	//Blocking invocation
	OMElement result = serviceClient.sendReceive(method);

	StringWriter writer = new StringWriter();
	result.serialize(XMLOutputFactory.newInstance()
	.createXMLStreamWriter(writer));
	writer.flush();

	System.out.println("Response: " + writer.toString());
	} catch (Exception ex) {
	ex.printStackTrace();
	}
	}
	} </pre>


	<p>The examples above assume that both the spring framework .jar and the
	axis2-spring-*.jar are under WEB-INF/lib. In such a case, the classes shown
	in this tutorial need to be placed in a JAR under WEB-INF/lib. In this
	example the JAR layout is:</p>

	<pre>./mySpring.jar
	./META-INF
	./META-INF/MANIFEST.MF
	./spring
	./spring/MyBean.class
	./spring/MyBeanImpl.class
	./spring/SpringAwareService.class</pre>

	<p>Since all the user classes are in mySpring.jar in this example, the AAR
	merely contains the services.xml file:</p>

	<pre>./springExample.aar
	./META-INF
	./META-INF/MANIFEST.MF
	./META-INF/services.xml</pre>

	<p>To run this example, make sure you have the axis2-spring*.jar that comes
	from the axis2-std-*-bin distro in the server side WEB-INF/lib, as well as
	the appropriate Spring jar - most will use the full spring.jar, but the
	minimum requirements are spring-core, spring-beans, spring-context, and
	spring-web. When running the client, you should see this output:</p>

	<pre>Response: <example1:string xmlns:example1="http://springExample.org/example1"
	xmlns:tns="http://ws.apache.org/axis2">Spring, emerge thyself</example1:string></pre>
	</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>