JAXenter

SpringServletContextObjectSupplier

Die Verwendung bietet sich an, wenn Axis2 im Rahmen einer Webanwendung läuft oder in eine bestehende Webanwendung eingebettet werden soll, die das Spring Framework verwendet. Eine Webanwendung, die auf Spring aufbaut, verwendet in aller Regel einen in der Datei web.xml konfigurierten und von Spring bereitgestellten ContextLoaderListener. Dieser teilt Spring mit, wo sich in der Webanwendung die entsprechende Spring-Konfiguration (der Application Context) befindet. Listing 1 zeigt eine beispielhafte Konfiguration von Spring in einer web.xml, in der festgelegt wird, dass der Application Context aus der Datei spring-app-context.xml aufgebaut werden soll, die sich direkt im WEB-INF-Verzeichnis der Webanwendung befindet.

Listing 1: Ausschnitt aus der Datei web.xml zur Konfiguration von Spring

1. <listener>
2. <listener-class>
3. org.springframework.web.context.ContextLoaderListener
4. </listener-class>
5. </listener>
7. <context-param>
8. <param-name>contextConfigLocation</param-name>
9. <param-value>/WEB-INF/spring-app-context.xml</param-value>
10. </context-param>

Besteht die Aufgabe nun also darin, bestimmte Services aus einer Webanwendung, die als Spring Beans vorliegen, mit einer Web-Service-Schnittstelle auszustatten, dann verwendet man üblicherweise SpringServletContextObjectSupplier. Das Deployment wird dabei zum Kinderspiel, denn das Service-Archiv besteht hier letztlich nur noch aus einem Deployment-Deskriptor (services.xml), in dem der Object Supplier konfiguriert wird, wie das Beispiel in Listing 2 zeigt.

Listing 2: Deployment Deskriptor in dem der SpringServletContextObjectSupplier konfiguriert wird

1. <service name="BankleitzahlSpringServletContext">
2. <description>
3. Service der die Spring-BLZ-Implementierung
4. über den ServletContext bereitstellt
5. </description>
7. <parameter name="ServiceObjectSupplier">
8. org.apache.axis2.extensions.spring.receivers.
9. SpringServletContextObjectSupplier
10. </parameter>
11. <parameter name="SpringBeanName">bankleitzahlService</parameter>
13. <operation name="searchBlz">
14. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"
15. class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
16. </operation>
17. </service>

SpringAppContextAwareObjectSupplier

Wenn man jedoch die Anforderung hat, sämtliche Spring Beans und deren Konfiguration isoliert in einem Service-Archiv (AAR) zu halten, weil ein Einbetten in eine bestehende Webanwendung nicht möglich oder gestattet ist, dann bietet sich die Verwendung des SpringAppContextAwareObjectSuppliers an. Während SpringServletContextObjectSupplier seine Spring-Konfiguration aus dem Servlet-Kontext der Webanwendung bezieht, muss der Entwickler bei Verwendung von SpringAppContextAwareObjectSupplier Axis2 mitteilen, wo die Spring-Konfiguration zu finden ist. Darüber hinaus ist man selbst dafür zuständig, den Application Context hochzufahren. Um dies zu bewerkstelligen, muss dem Service-Archiv zusätzlich zu den eigentlichen Spring Beans und deren Konfiguration (Application Context) noch eine spezielle Web-Service-Implementierung mitgegeben werden, der das Axis2-Interface ServiceLifeCycle implementiert. Diese spezielle Implementierung ist letztlich dafür verantwortlich, vor der ersten Verwendung des Web Service die Spring-Konfiguration zu lesen und den Application Context aufzubauen. Die Idee hinter dem ServiceLifeCycle-Interface kann man mit Servlets vergleichen: Analog zu den Methoden init und destroy bei Servlets, bieten die Methoden startUp und shutDown in ServiceLifeCycle-Implementierungen die Möglichkeit, entsprechende Initialisierungs- und Aufräumarbeiten durchzuführen. In Listing 3 sieht man eine beispielhafte Implementierung von ServiceLifeCycle, die einen Spring Application Context innerhalb eines AARs hochfährt.

Listing 3: Ausschnitt aus der Datei web.xml zur Konfiguration von Spring

1. public class SpringInit implements ServiceLifeCycle {
3. private static final String BLZ_CONTEXT_XML =
4. "spring-app-context.xml";
6. // Dummy-Methode, dieser Service soll ja nur den
7. // Application Context hochfahren !
8. public OMElement springInit(OMElement ignore) {
9. return null;
10. }
12. public void startUp(ConfigurationContext configctx,
13. AxisService service) {
15. try {
17. ClassLoader classLoader = service.getClassLoader();
18. ClassPathXmlApplicationContext applicationContext = new
19. ClassPathXmlApplicationContext( new String[]
20. { BLZ_CONTEXT_XML }, false);
21. applicationContext.setClassLoader(classLoader);
22. applicationContext.refresh();
24. } catch (Exception e) {
25. e.printStackTrace();
26. }
27. }
29. public void shutDown(ConfigurationContext configctx,
30. AxisService service) {
31. }
32. }

Eine detaillierte Beschreibung der soeben vorgestellten Object Supplier für die Spring-Integration mit Axis2 würde den Rahmen dieses Artikels sprengen, daher sei an dieser Stelle auf das Axis2-Buch verwiesen. Hier wird vollständig und mit vielen Beispielen (siehe Kapitel 12, ab Seite 386 ff) beschrieben, was mit Object Suppliers möglich ist.