Axis2. Un completo ejemplo de creación de un servicio Web
En este tutorial vamos realizar las siguientes tareas:
- Definición de una interface Java a partir de la cual generaremos el servicio Web.
- Generar la definición del servicio Web (WSDL) a partir del interface.
- Generar el esqueleto (Skeleton) del servicio Web del WSDL.
- Implementar la lógica de negocio del servicio Web.
- Generar el archivo del Servicio Web AAR (Axis Archive)
- Desplegar el servicio Web.
- Generar un cliente.
- Invocar el servicio Web.
Definición de una interface Java a partir de la cual generaremos el servicio Web
|
1 2 3 4 5 6 7 8 9 10 |
package com.autentia.ws.sample1; /** * Interfaz Calculadora * @author Carlos García. * @see http://www.mobiletest.es */ public interface Calculadora { public int sumar(int op1, int op2); } |
Generar la definición del servicio Web (WSDL) a partir del interface.
|
1 |
%AXIS_HOME%/bin/java2wsdl -of calculadora.wsdl -cn com.autentia.ws.sample1.Calculadora |
- En donde el parámetro
ofes el nombre del archivo WSDL que deseamos generar - En donde el parámetro
cnes el nombre de la clase a partir de la cual deseamos generar el WSDL.
Archivo generado: calculadora.xsdl
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
<?xml version="1.0" encoding="UTF-8"?> <wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:ns0="http://sample1.ws.autentia.com" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:ns1="http://org.apache.axis2/xsd" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" targetNamespace="http://sample1.ws.autentia.com"> <wsdl:types> <xs:schema xmlns:ns="http://sample1.ws.autentia.com" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://sample1.ws.autentia.com"> <xs:element name="sumar"> <xs:complexType> <xs:sequence> <xs:element minOccurs="0" name="param0" type="xs:int"/> <xs:element minOccurs="0" name="param1" type="xs:int"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="sumarResponse"> <xs:complexType> <xs:sequence> <xs:element minOccurs="0" name="return" type="xs:int"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> </wsdl:types> <wsdl:message name="sumarRequest"> <wsdl:part name="parameters" element="ns0:sumar"/> </wsdl:message> <wsdl:message name="sumarResponse"> <wsdl:part name="parameters" element="ns0:sumarResponse"/> </wsdl:message> <wsdl:portType name="CalculadoraPortType"> <wsdl:operation name="sumar"> <wsdl:input message="ns0:sumarRequest" wsaw:Action="urn:sumar"/> <wsdl:output message="ns0:sumarResponse" wsaw:Action="urn:sumarResponse"/> </wsdl:operation> </wsdl:portType> <wsdl:binding name="CalculadoraSOAP11Binding" type="ns0:CalculadoraPortType"> <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/> <wsdl:operation name="sumar"> <soap:operation soapAction="urn:sumar" style="document"/> <wsdl:input> <soap:body use="literal"/> </wsdl:input> <wsdl:output> <soap:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:binding name="CalculadoraSOAP12Binding" type="ns0:CalculadoraPortType"> <soap12:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/> <wsdl:operation name="sumar"> <soap12:operation soapAction="urn:sumar" style="document"/> <wsdl:input> <soap12:body use="literal"/> </wsdl:input> <wsdl:output> <soap12:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:binding name="CalculadoraHttpBinding" type="ns0:CalculadoraPortType"> <http:binding verb="POST"/> <wsdl:operation name="sumar"> <http:operation location="Calculadora/sumar"/> <wsdl:input> <mime:content type="text/xml" part="sumar"/> </wsdl:input> <wsdl:output> <mime:content type="text/xml" part="sumar"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:service name="Calculadora"> <wsdl:port name="CalculadoraSOAP11port_http" binding="ns0:CalculadoraSOAP11Binding"> <soap:address location="http://localhost:8080/axis2/services/Calculadora"/> </wsdl:port> <wsdl:port name="CalculadoraSOAP12port_http" binding="ns0:CalculadoraSOAP12Binding"> <soap12:address location="http://localhost:8080/axis2/services/Calculadora"/> </wsdl:port> <wsdl:port name="CalculadoraHttpport" binding="ns0:CalculadoraHttpBinding"> <http:address location="http://localhost:8080/axis2/services/Calculadora"/> </wsdl:port> </wsdl:service> </wsdl:definitions> |
Generar el esqueleto (Skeleton) del servicio Web a partir del WSDL.
|
1 |
%AXIS_HOME%/bin/wsdl2java -p com.autentia.ws.sample1.servidor -S . -or -ss -sd -u --noMessageReceiver -uri calculadora.wsdl |
- El parámetro
pindica el nombre del paquete donde deseamos que se generen las clases. - El parámetro
Sindica el nombre de la carpeta en donde deseamos que se generen las clases (por defecto crea una carpeta src) - El parámetro
orindica que se sobreescriban los archivos. - El parámetro
ssindica que se generen las clases del servicio web (Por defecto NO se generan) - El parámetro
sdindica que se genere el descriptor de despliegue del servicio web. - El parámetro
uindica que no se generen innerclases sino que cada clase está en un archico propio. - El parámetro
noMessageReceiverindica que no se genere un Message Receiver especifico para el servicio Web. - El parámetro
uriindica el WSDL de partida.
El descriptor de despliegue generado (services.xml):
|
1 2 3 4 5 6 7 8 9 10 11 |
<?xml version="1.0" encoding="UTF-8"?> <serviceGroup> <service name="Calculadora"> <parameter name="ServiceClass">com.autentia.ws.sample1.servidor.CalculadoraSkeleton</parameter> <operation name="sumar"> <actionMapping>urn:sumar</actionMapping> <outputActionMapping>urn:sumarResponse</outputActionMapping> <messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/> </operation> </service> </serviceGroup> |
Implementar la lógica de negocio del servicio Web.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
/** * Implementación del Servicio Web * @author Carlos García. * @see Creador de http://www.mobiletest.es */ package com.autentia.ws.sample1.servidor; public class CalculadoraSkeleton { public com.autentia.ws.sample1.SumarResponse sumar(com.autentia.ws.sample1.Sumar sumar) { com.autentia.ws.sample1.SumarResponse response = new com.autentia.ws.sample1.SumarResponse(); response.set_return(sumar.getParam0() + sumar.getParam1()); return response; } } |
Generar el archivo del Servicio Web AAR (Axis Archive)
Para desplegar un servicios Web en Axis2, debemos generar un archivo AAR.
Los archivos AAR, son como los archivos WAR, EAR. Es decir son archivos JAR o ZIP que contienen archivos y directorios bajo una estructura definida.
Los pasos generar el archivo aar son:
- Creamos una carpeta de nombre
Calculadora - Dentro de la carpeta
Calculadoracopiamos las clasescom.autentia.ws.sample1manteniendo la estructura. - Dentro de la carpeta
Calculadoracreamos una carpeta de nombreMETA-INFy compiamos dentro el archivoservices.xml. - Empaquetamos la carpeta
Calculadoraen un archivoCalculadora.aar.
Para ello estando dentro del directorioCalculadoraejecutamos la siguiente instrucción:
1%JAVA_HOME%/bin/jar -cvf Calculadora.aar *
Desplegar el servicio Web.
Existen varios métodos de despliegue de un Servicio Web en Axis2, los más comunes son:
- A través la opción «Upload Service» de la página de administración de Axis2.
- Copiar el «AAR» al directorio
<AXIS_WEBAPP_HOME>\repository\services. Siendo AXIS_WEBAPP_HOME el directorio donde está desplegado Axis2 en el servidor de aplicaciones o contenedor de Servlet.
Generar un cliente
Vamos a generar el cliente desde la propia descripción del servicio Web deplegado.
|
1 |
%AXIS_HOME%/bin/wsdl2java -p com.autentia.ws.sample1.cliente -d adb -S . -or -uri http://127.0.0.1:8080/axis2/services/Calculadora?wsdl |
- El parámetro
pindica el nombre del paquete donde deseamos que se generen las clases. - El parámetro
dindica el tipo de Databinding, es decir, el mapeo entre XML y objetos Java que deseamos.
Usamos el tipoADB (Axis Data Binding)que usaAXIOM (Axis Object Model)un modelo especialmente creado
para Axis que proporciona un alto rendimiento debido a que está basado en el API deStAX (Streaming API for XML) (Alternativas a DOM y SAX)
una forma de parsear XML bajo demanda, es decir, sólo se parsea lo que se necesita en cada momento. - El parámetro
Sindica el nombre de la carpeta en donde deseamos que se generen las clases (por defecto crea una carpeta src) - El parámetro
uriindica el WSDL de partida.
Invocar el servicio Web
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
package com.autentia.ws.sample1.test; import com.autentia.ws.sample1.cliente.*; import com.autentia.ws.sample1.cliente.CalculadoraStub.Sumar; import com.autentia.ws.sample1.cliente.CalculadoraStub.SumarResponse; /** * Ejemplo de invocación SINCRONA del servicio Web * @author Carlos García. * @see Creador de http://www.mobiletest.es */ public class Appication1 { /** * Ejemplo de invocación del servicio */ public static void main(String[] args) throws Exception { CalculadoraStub stub = new CalculadoraStub(); Sumar operacion = new Sumar(); SumarResponse response = null; // Establecemos los parámetros de la operación operacion.setParam0(100); operacion.setParam1(200); // Invocamos el WS response = stub.sumar(operacion); // Mostramos el resultado System.out.println(response.get_return()); } } |
Conclusiones
Bueno, como podéis ver la generación de servicios Web con Axis2 así como su despliegue o generación de clientes no tiene mucha dificultad.
Axis2 soporta los patrones de mensajería (Síncrona/Asíncrona, Comunicación 1 a 1, 1 a N, N a M, mensajería por eventos, etc.) definidos WSDL 2, así como varios tipos de DataBinding que se salen del alcance de este tutorial.
Un saludo, Carlos García.
Saludos y si quisiera poner una autentican básica de http al querer consumir el método Calculadora como lo tendría que hacer.