You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by ro...@apache.org on 2006/07/16 18:54:44 UTC
svn commit: r422474 - in /webservices/axis2/trunk/java: modules/spring/
modules/spring/src/org/apache/axis2/extensions/spring/receivers/
xdocs/latest/
Author: robertlazarski
Date: Sun Jul 16 09:54:43 2006
New Revision: 422474
URL: http://svn.apache.org/viewvc?rev=422474&view=rev
Log:
Spring refactoring
Added:
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringAppContextAwareObjectSupplier.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringServletContextObjectSupplier.java
Removed:
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringAbstractInMessageReceiver.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringAbstractInOutAsyncMessageReceiver.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringAbstractInOutSyncMessageReceiver.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringAbstractMessageReceiver.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringAbstractRobustInMessageReceiver.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringMakeNewServiceObject.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringRPCInOnlyMessageReceiver.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringRPCInOutAsyncMessageReceiver.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringRPCMessageReceiver.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringRawXMLINOnlyMessageReceiver.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringRawXMLINOutAsyncMessageReceiver.java
webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringRawXMLINOutMessageReceiver.java
Modified:
webservices/axis2/trunk/java/modules/spring/project.xml
webservices/axis2/trunk/java/xdocs/latest/spring.html
Modified: webservices/axis2/trunk/java/modules/spring/project.xml
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/spring/project.xml?rev=422474&r1=422473&r2=422474&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/spring/project.xml (original)
+++ webservices/axis2/trunk/java/modules/spring/project.xml Sun Jul 16 09:54:43 2006
@@ -112,6 +112,14 @@
<module>true</module>
</properties>
</dependency>
+ <dependency>
+ <groupId>servletapi</groupId>
+ <artifactId>servletapi</artifactId>
+ <version>${servletapi.version}</version>
+ <properties>
+ <module>true</module>
+ </properties>
+ </dependency>
</dependencies>
<build/>
Added: webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringAppContextAwareObjectSupplier.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringAppContextAwareObjectSupplier.java?rev=422474&view=auto
==============================================================================
--- webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringAppContextAwareObjectSupplier.java (added)
+++ webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringAppContextAwareObjectSupplier.java Sun Jul 16 09:54:43 2006
@@ -0,0 +1,68 @@
+/*
+ * Copyright 2004,2005 The Apache Software Foundation.
+ *
+ * Licensed 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.
+ */
+
+package org.apache.axis2.extensions.spring.receivers;
+
+import org.apache.axis2.AxisFault;
+import org.apache.axis2.context.MessageContext;
+import org.apache.axis2.description.AxisService;
+import org.apache.axis2.description.Parameter;
+import org.apache.axis2.i18n.Messages;
+import org.apache.axis2.Constants;
+
+import javax.servlet.ServletContext;
+
+import org.springframework.context.ApplicationContext;
+import org.springframework.web.context.support.WebApplicationContextUtils;
+
+public class SpringAppContextAwareObjectSupplier {
+ public static final String SERVICE_SPRING_BEANNAME = "SpringBeanName";
+
+ /**
+ * Method getServiceObject that is Spring aware via ServletContext
+ *
+ * @param msgContext
+ * @return Returns Object.
+ * @throws AxisFault
+ */
+ public static Object getServiceObject(MessageContext msgContext) throws AxisFault {
+ try {
+ AxisService service =
+ msgContext.getOperationContext().getServiceContext().getAxisService();
+ // Name of spring aware bean to be injected, taken from services.xml
+ // via 'SERVICE_SPRING_BEANNAME ' . The Bean and its properties are pre-configured
+ // as normally done in a spring type of way and subsequently loaded by Spring.
+ // Axis2 just assumes that the bean is configured and is in the classloader.
+ Parameter implBeanParam = service.getParameter(SERVICE_SPRING_BEANNAME);
+ String beanName = ((String) implBeanParam.getValue()).trim();
+ if (beanName != null) {
+ // ApplicationContextHolder implements Spring interface ApplicationContextAware
+ ApplicationContext aCtx = ApplicationContextHolder.getContext();
+ if (aCtx == null) {
+ throw new Exception("Axis2 Can't find Spring's ApplicationContext");
+ } else if (aCtx.getBean(beanName) == null) {
+ throw new Exception("Axis2 Can't find Spring Bean: " + beanName);
+ }
+ return aCtx.getBean(beanName);
+ } else {
+ throw new AxisFault(Messages.getMessage("paramIsNotSpecified", "SERVICE_SPRING_BEANNAME"));
+ }
+ } catch (Exception e) {
+ throw AxisFault.makeFault(e);
+ }
+ }
+}
+
Added: webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringServletContextObjectSupplier.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringServletContextObjectSupplier.java?rev=422474&view=auto
==============================================================================
--- webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringServletContextObjectSupplier.java (added)
+++ webservices/axis2/trunk/java/modules/spring/src/org/apache/axis2/extensions/spring/receivers/SpringServletContextObjectSupplier.java Sun Jul 16 09:54:43 2006
@@ -0,0 +1,72 @@
+/*
+ * Copyright 2004,2005 The Apache Software Foundation.
+ *
+ * Licensed 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.
+ */
+
+package org.apache.axis2.extensions.spring.receivers;
+
+import org.apache.axis2.AxisFault;
+import org.apache.axis2.context.MessageContext;
+import org.apache.axis2.description.AxisService;
+import org.apache.axis2.description.Parameter;
+import org.apache.axis2.i18n.Messages;
+import org.apache.axis2.Constants;
+
+import javax.servlet.ServletContext;
+
+import org.springframework.context.ApplicationContext;
+import org.springframework.web.context.support.WebApplicationContextUtils;
+
+public class SpringServletContextObjectSupplier {
+ public static final String SERVICE_SPRING_BEANNAME = "SpringBeanName";
+
+ /**
+ * Method getServiceObject that is Spring aware via ServletContext
+ *
+ * @param msgContext
+ * @return Returns Object.
+ * @throws AxisFault
+ */
+ public static Object getServiceObject(MessageContext msgContext) throws AxisFault {
+ try {
+ AxisService service =
+ msgContext.getOperationContext().getServiceContext().getAxisService();
+ // Name of spring aware bean to be injected, taken from services.xml
+ // via 'SERVICE_SPRING_BEANNAME ' . The Bean and its properties are pre-configured
+ // as normally done in a spring type of way and subsequently loaded by Spring.
+ // Axis2 just assumes that the bean is configured and is in the classloader.
+ Parameter implBeanParam = service.getParameter(SERVICE_SPRING_BEANNAME);
+ String beanName = ((String) implBeanParam.getValue()).trim();
+ if (beanName != null) {
+ ServletContext servletContext = (ServletContext) msgContext.getOptions().
+ getProperty(Constants.SERVLET_CONTEXT);
+ if (servletContext == null) {
+ throw new Exception("Axis2 Can't find ServletContext");
+ }
+ ApplicationContext aCtx = WebApplicationContextUtils.getWebApplicationContext(servletContext);
+ if (aCtx == null) {
+ throw new Exception("Axis2 Can't find Spring's ApplicationContext");
+ } else if (aCtx.getBean(beanName) == null) {
+ throw new Exception("Axis2 Can't find Spring Bean: " + beanName);
+ }
+ return aCtx.getBean(beanName);
+ } else {
+ throw new AxisFault(Messages.getMessage("paramIsNotSpecified", "SERVICE_SPRING_BEANNAME"));
+ }
+ } catch (Exception e) {
+ throw AxisFault.makeFault(e);
+ }
+ }
+}
+
Modified: webservices/axis2/trunk/java/xdocs/latest/spring.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/latest/spring.html?rev=422474&r1=422473&r2=422474&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/spring.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/spring.html Sun Jul 16 09:54:43 2006
@@ -9,17 +9,24 @@
<h1>Axis2 intergration with the Spring Framework</h1>
<p>The idea behind Axis2 and Spring integration is that Axis2 simply needs to
-have Spring inject its ApplicationContext object into an Axis2 class. The web
-service itself acts like any other Spring wired bean. No further spring
-configuration is necessary. These Spring beans can be loaded any way desired,
-as Axis2 has no file dependencies from Spring. Spring versions 1.2.6 and 1.2.8 have
-been tested, but probably any version would work as only core functionality is required.</p>
+have Spring supply one of its pre-loaded beans to the Axis2 Message Receiver
+defined in the AAR services.xml . While Axis2 typically uses reflection to instantiate
+the ServiceClass defined in the services.xml that the Message Receiver will use,
+alternatively one can define a ServiceObjectSupplier that will have supply the Object.
+This guide will show how to use two seperate ServiceObjectSupplier classes that are
+part of the Axis2 standard distrubution: One for use with a servlet container, and one
+without. Once configured, the web service itself acts like any other Spring wired bean.
+No further spring configuration is necessary. These Spring beans can be loaded any way
+desired, as Axis2 has no file dependencies from Spring. Spring versions 1.2.6 and 1.2.8
+have been tested, but probably any version would work as only core functionality is
+required.</p>
<p>This guide assumes some basic knowledge of Axis2. See the userguide for more info.</p>
<p>From an Axis2 standpoint, two needed hooks are to be placed into the AAR services.xml:
-The spring message receiver that follows the desired Message Exchange Pattern (MEP),
-and the name of the Spring bean that is your web service.</p>
+The ServiceObjectSupplier that hooks Axis2 and Spring together, and the name of 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>
<p>For the purpose of this example, and for no other reason besides simplicity, we'll
configure Spring via a WAR file's web.xml. Lets add a context-param and a listener:</p>
@@ -31,8 +38,32 @@
<param-value>/WEB-INF/applicationContext.xml</param-value>
</context-param></pre>
-<p>A simple Spring configuration is shown below, including the Axis2 hook, the web service,
+<p>Here we will show two examples of Spring's applicationContext.xml . The first example
+should be familair to any Spring user: </p>
+
+<p>A simple Spring configuration is shown below, including the Axis2 hooks, the web service,
and a bean that will be injected into the web service. This files path is /WEB-INF/applicationContext.xml:</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 interface / 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> In the case Axis2 can't get a ServletContext, you have the option of defining a bean that takes
+advantage of Spring's internal abilities to provide an Application Context, with a bean ref 'applicationContext' :
+
<pre><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
@@ -55,32 +86,44 @@
</bean>
</beans></pre>
-<p>Lets move now to the Axis2 services.xml file. This example uses an In / Out
-synchronous MEP, but really, just pick a supported MEP and use a Spring prefix.
-The other required part is the bean name, as shown below.
-
-IMPORTANT: The ServiceClass referenced MUST be placed in the Threaded Context Classloader
-(TCCL) - in a typical servlet container that simply is WEB-INF/lib or WEB-INF/classes. This is
-because Spring uses the TCCL, and loads its beans from there. Inside the AAR, unfortunately,
-won't work. </p>
-<pre><service name="SpringAwareService">
+
+<p>Lets move now to the Axis2 services.xml file. Note that while we are using RawXMLINOutMessageReceiver
+as the Message Receiver, currently all Message Receviers extend AbstractMessageReceiver and therefore are
+automatically supported. IMPORTANT: The SpringBeanName referenced MUST be placed in the Threaded Context
+Classloader (TCCL) - in a typical servlet container that simply is WEB-INF/lib or WEB-INF/classes. This is
+because Spring uses the TCCL, and loads its beans from there. Inside the AAR, unfortunately, won't work. </p>
+
+<p>If the service is running in a Servlet Container, ie, Axis2 will be able to get a hold of
+ServletContext, the services.xml for the example would be using SpringServletContextObjectSupplier such as: </p>
+
+<pre> <service name="SpringAwareService">
<description>
simple spring example
</description>
- <!-- place class in TCCL, such as WEB-INF/classes -->
- <parameter name="ServiceClass"
- locked="false">spring.SpringAwareService</parameter>
- <parameter name="SpringBeanName"
- locked="false">springAwareService</parameter>
+ <parameter name="ServiceObjectSupplier" locked="false">org.apache.axis2.extensions.spring.receivers.SpringServletContextObjectSupplier</parameter>
+ <parameter name="SpringBeanName" locked="false">springAwareService</parameter>
<operation name="getValue">
- <messageReceiver
- class="org.apache.axis2.extensions.spring.receivers.SpringRawXMLINOutMessageReceiver"/>
+ <messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/>
</operation>
-</service></pre>
+</service> </pre>
+
+<p>If the service is _NOT_ running in a Servlet Container, ie, Axis2 will _NOT_ be able to get a hold of
+ServletContext, the services.xml for the example would be using SpringAppContextAwareObjectSupplier such as: </p>
+
+<pre> <service name="SpringAwareService">
+ <description>
+ simple spring example
+ </description>
+ <parameter name="ServiceObjectSupplier" locked="false">org.apache.axis2.extensions.spring.receivers.SpringAppContextAwareObjectSupplier</parameter>
+ <parameter name="SpringBeanName" locked="false">springAwareService</parameter>
+ <operation name="getValue">
+ <messageReceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver"/>
+ </operation>
+</service> </pre>
<p>From here, its just standard Axis2 coding, only now the service has Spring wiring
capabilities. The service is below: </p>
-<pre>package org;
+<pre>package spring;
import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.om.OMElement;
@@ -90,10 +133,10 @@
public class SpringAwareService {
- private MyBeanImpl myBean = null;
+ private MyBean myBean = null;
//spring 'injects' this implementation
- public void setMyBean(MyBeanImpl myBean) {
+ public void setMyBean(MyBean myBean) {
this.myBean = myBean;
}
@@ -109,21 +152,21 @@
payload.addChild(response);
return payload;
}
-}</pre>
+} </pre>
+
<p>For those new to Spring, one of the ideas is that you program to an Interface, and the
implementation is pluggable. This idea is referenced in the Spring config file above. Below is
-the interface followed by the implementation: </p>
+the interface: </p>
<pre>package spring;
/** Interface for Spring aware Bean */
public interface MyBean {
- String emerge(String s);
-}
-
-package spring;
+ String emerge();
+}</pre>
-/** Spring wired implementation */
-public class MyBeanImpl {
+<p>Here's the implementation: </p>
+<pre>/** Spring wired implementation */
+public class MyBeanImpl implements MyBean {
String str = null;
// spring 'injects' this value
@@ -135,6 +178,7 @@
return str;
}
}</pre>
+
<p>Lastly here's the client - not really necessary for the example, other than for completeness:</p>
<pre>package client;
@@ -191,8 +235,8 @@
ex.printStackTrace();
}
}
-}</pre>
-<p>Running the client, you should see this output:</p>
+} </pre>
+<p>To run this example, make sure you have the axis2-spring*.jar in the server side WEB-INF/lib . 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>
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org