Manual Usuario Invocador de Servicios
Contents
1. a Agencia de ic Inform tica y Comunicaciones Framework Atlas de la Comunidad de Madrid Servicio de Invocaci n de Servicios invocador creado applicationContext services xml lt xml version 1 0 encoding UTF 8 2 gt lt beans xmlns http www springframework org schema beans xmlns xsi http www w3 org 2001 XMLSchema instance xmlns p http www springframework org schema p xmlns context http www springframework org schema context xmlns tx http www springframework org schema tx xsi schemalocation gt lt import resource applicationContext OptiwsService xml gt QU gt Definicion de todos los servicios de la aplicacion gt lt gt lt bean id facade class atlasfrm samples services facade BloquefuncionalnFacadeIlmpl p clienteService ref clienteService p optiService ref 0ptiwsService gt Des lt beans gt BloquefuncionalnFacadelmpl java fService public class BloquefuncionalnFacadelmpl implements BloquefuncionalnFacade private OptiwsService optiService public void setOptiService OptiwsService optiService this optiService optiService pk Llamada al WS de Opti return numero generado por el webservic el public String getNumero throws ServiceException try return this optiService codigoDeclaracion2 40 10 1 catch RemoteException e log error Error en llamada al WS e th2. Framework La forma recomendada de cargar el fichero de Spring es mediante una sentencia include en el fichero de servicios applicationContext services xml lt xml version 1 0 encoding UTF 8 gt lt beans xmlns http www springframework org schema beans xmlns xsi http www w3 org 2001 XMLSchema instance xmlns p http www springframework org schema p xmlns context http www springframework org schema context xmlns tx http www springframework org schema tx xsi schemaLlocation http www springframework org schema beans http www springframework org schema beans spring beans 2 5 xsd http www springframework org schema context http www springframework org schema context spring context 2 5 xsd http www springframework org schema tx http www springframework org schema tx spring tx 2 5 xsd gt lt import resource applicationContext OptiwsService xml gt lt gt o Definicion de todos los servicios de la aplicacion gt lt gt Esa lt beans gt 5 3 Enlazar la dependencia en la fachada e implementar llamada En el mismo fichero applicationContext services xml del apartado anterior est n las definiciones de las fachadas del proyecto Debe a adirse la dependencia a la fachada como se har a con cualquier otro servicio del proyecto Una vez a adida la dependencia a la fachada podr n implementarse m todos de uso en esta que utilicen el ROS kk k jm 12 de 14
3. de la Comunidad de Madrid Servicio de Invocaci n de Servicios 1 INTRODUCCI N Muchas de las aplicaciones que se desarrollan para la Comunidad de Madrid necesitan acceder a servicios web tanto servicios que se han desarrollado espec ficamente para la tramitaci n electr nica como otros servicios web que incluso pueden estar fuera de nuestros entornos Dada la amplia variedad de tipos de servicios web que nos podemos encontrar y los distintos tipos de seguridad que nos pueden requerir los citados servicios web se ha desarrollado el componente Invocador de Servicios de Atlas para facilitar la creaci n de los clientes de acceso a los servicios y que mediante una sencilla configuraci n se le pueda incluir los requisitos de seguridad requeridos 1 1 Audiencia objetivo Este documento esta orientado a desarrolladores java que quieran invocar a un servicio web desde un aplicativo que se desarrolla con Atlas 1 2 Conocimientos Previos Para un completo entendimiento del documento el lector deber tener conocimientos previos sobre las siguientes tecnolog as Spring Framework Servicios Web Axis21 5 WSS4J Seguridad uso b sico de certificados claves y almacenes con openssl y keytool AAA HRK 4 de 14 a Agencia de ic Inform tica y Comunicaciones de la Comunidad de Madrid 2 DESCRIPCI N Framework Atlas Servicio de Invocaci n de Servicios Este componente se basa en los siguientes elementos
4. ATLAS MANUAL DE USUARIO Servicio de Invocaci n De Servicios Para Axis 2 Versi n 1 0 rea de Integraci n y Arquitectura de Aplicaciones FFY a a Cff p Agencia de Inform tica y Comunicaciones de la Comunidad de Madrid RTS Agencia de a Framework Atlas ic Inform tica y Comunicaciones e e a de la Comunidad de Madrid Servicio de Invocaci n de Servicios Hoja de Control Manual de Usuario Invocador de Servicios MAS EA NORMATIVA ATLAS Responsable rea de Integraci n y Arquitectura de Aplicaciones Registro de Cambios Versi n Causa del Cambio Responsable del Cambio Fecha del Cambio Area de Integraci n y Arquitectura de 1 0 Versi n inicial del documento Aplicaciones 02 11 2010 kkk k kkk 2de 14 RS Agencia de a Framework Atlas ic Inform tica y Comunicaciones e e e de la Comunidad de Madrid Servicio de Invocaci n de Servicios ndice To INTRODUCCION id 1 1 AUDIENCIA OBJETIVO cccccccccnononcnnncnnnonononononononononononn nono nn nn nn nn nn nn nn nn nn nn nn nn nn nn nn nn iato a aaia asana eSa 4 1 2 CONOCIMIENTOS PREVIOS cccccccccncncnoncnnnononcnonononononononononononono nono nonnnnnnnonnnnnnnrnonnnnnnnonononononnnnnonononnnonononnnnnnnonnnonnnnnnnononininons 4 r z 3 INSTALACION Y CONFIGURA ClONooccoccoononccnnonnonncnnonacnnnnocononncnnonncnnonnconocononccnnonnonncnn seess coc noo non cc nono ronncc rro noc cccncnnosa O 3 1 INCLUSI N DE DEPENDENCIA EN FICHERO POM X
5. ML cocooccccnconcnnconnnccnnoncnnonnonononnnnnccnnnnnnronnnnnnrnnnnnn none nnn nena nn n non nnnrnnnnnnaronnnss 5 3 2 INSTALACI N Y CONFIGURACI N DEL PLUGIN DE MAVEN ATLASFRM CLIENTEWS WSDL2CODE MAVEN PLUGIN 6 3 2 1 Generaci n de un cliente de Servicio Web ooonomocoooconncnnnnannannnnrnncnnana nono nono nnannonn nono no cnnnna nono nro rnnannan enero nro nnnaannnnnanons 6 3 2 2 Genearci n de m ltiples clientes de servicio web ssseeeeeeeeeeeeseersireereresrserrerisreresrsrsrereeresssrsenresreesersenrsere 7 3 23 Par metros de configuraci n del plugiN o onoonicnnninnnnnnnnnnnoocnnnnnncnncnannn none no none on rnn anno nn nana no nana cren a cnn nena cnnrnnannnn 8 4 GENERACION DEL CLIENTE DEL SERVICIO WEB eseseseresereseeeseeeeeeceeeeeeeeeseeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeseeeeeeeeeeeeeeeseeese Y 5 USO DEL INVOCADOR DE SERVICIOS ccnooconiononconononconosnonconosnonconooonconosnonconosoonconooonconocoonconoconconosconconosconconosconosnosos LL 5 1 PARAMETRIZACI N DEL ENDPOINT occcccccccncnnonnncncnnonannononcnnnnonconononcncononnnnanennnnnnnnonnnnnnnnnnnonononnennnn non nonannanencnnorancnnanenencnnos 11 5 2 INCLUIR LA DEFINICI N DEL INVOCADOR EN EL CONTEXTO DE SPRING FRAMEWORK si 5 3 ENLAZAR LA DEPENDENCIA EN LA FACHADA E IMPLEMENTAR LLAMADA ccocococononononononononononononononononononononnnnnnncnnacananones 12 AAA HRK 3 de 14 def Agencia de e Framework Atlas ic Inform tica y Comunicaciones
6. arametrizar el endpoint por defecto en el fichero environment properties Para ello se crear una variable ws endpoint xxxx en este fichero donde XXXX es el nombre del servicio en min sculas o el nombre del paquete final si se utiliz el par metro serviceNameAsPackage como se recomienda En el ejemplo el par metro se llamar ws endpoint optiwsservice environment properties Esa Endpoints de webservice ws endpoint optiwsservice http desarrollo madrid org optiws services OPTIWSSERVICE ATENCI N Los par metros endpoint han de crearse en TODOS los ficheros environment properties del proyecto aunque no se sepan las URLs en los distintos entornos A continuaci n habr que modificar el fichero de Spring applicationContext xxxxService xml generado y cambiar el valor del endpoint por defecto por el par metro creado kk AA Akk 11 de 14 ERAJ Agencia de ui gt s Framework Atlas ic Inform tica y Comunicaciones B Ba de la Comunidad de Madrid Servicio de Invocaci n de Servicios applicationContext OptiwsService xml asa lt Definicion del endpoint Puede ser necesario insertar el valor a traves del fichero environment properties gt lt bean id 0ptiwsServiceEndpoint class java lang String gt lt constructor arg value S ws endpoint optiwsservice gt lt bean gt sss 5 2 Incluir la definici n del invocador en el contexto de Spring
7. das Por defecto false skipGeneratioin Si es true el plugin no intentar generar ning n cliente Se recomienda usar este par metro cuando se modifiquen los nombres de los ficheros generados de lo contrario se generar n ficheros nuevos con los nombres originales Por defecto false outputDirectory Directorio de fuentes donde se generar n las clases del cliente de servicio web Por defecto src main java resourceOutputDirectory Directorio de recursos donde se generar n los ficheros de spring del cliente Por defecto src main resources conf testOutputDirectory Directorio de fuentes donde se generar n los tests unitarios Por defecto src test java testResourceOutputDirec Directorio de recursos de test donde se generar n los ficheros de configuraci n de Spring Por defecto tary necesarios si los hubiere src test resources conf syncMode Modo de conexi n al webservice Por defecto sync s ncrono kk Ak kk xk jm 8 de 14 ERAS Agencia de o Framework Atlas ic Inform tica y Comunicaciones ns p K de la Comunidad de Madrid Servicio de Invocaci n de Servicios generateTestcase Indica si generar o no una clase de test para el Por defecto true cliente de webservice unpackClasses Genera las clases en distintos ficheros Por defecto true generateServerSidelnterf Genera el intefaz java del servicio web Por defecto true r
8. e Plugin Maven axistools e Localizador de servicios de Spring e Axis2 1 5 Se ha creado una extensi n del plugin wsdl2code que se llama atlasfrm clientews wsdl2code maven plugin al cual se le han a adido las siguientes funcionalidades e Generaci n de Test Unitarios e Generaci n de la configuraci n de Spring necesaria para la ejecuci n de los test El plugin de Maven se configura indicando cual es el fichero wsdl a partir del cual se va a generar el cliente A partir de esta configuraci n mediante Maven se generar n autom ticamente las clases clientes y se incluir n en el proyecto Adem s se generaran clases de prueba de estos clientes En ocasiones nos podemos encontrar con servicios web a los que se les ha dotado de medidas de seguridad En este documento se explicar m s adelante como implementar la comunicaci n con este tipo de servicios 3 INSTALACI N Y CONFIGURACI N En los siguientes pasos comentaremos como configurar generar y utilizar el componente invocador de servicios web 3 1 Inclusi n de dependencia en fichero pom xml ATENCION Si se ha partido de uno de los arquetipos del framework Atlas no es necesario incluir la dependencia A adir en la siguiente dependencia en el fichero pom xml pom xml lt dependency gt lt groupId gt atlasfrm lt groupId gt lt artifactid gt atlasfrm dep service lt artifactld gt lt version gt fatlasfrm dep service ve
9. eber n generarse tantos tags lt execution gt como clientes deban generarse cada uno con su configuraci n No obstante se recomienda especificar la configuraci n comun a todas las ejecuciones a nivel del plugin como se muestra en el ejemplo siguiente pom xml lt l Plugin para invocador de servicios de negocio Descomentar si se desea utilizar esta caracteristica gt lt plugin gt lt groupId gt atlasfrm lt groupId gt lt artifactld gt atlasfrm clientews wsdl2code maven plugin lt artifactld gt lt version gt fatlasfrm clientews wsdl2code plugin version lt version gt lt configuration gt lt packageName gt atlasfrm samples ws client lt packageName gt lt serviceNameAsPackage gt true lt serviceNameAsPackage gt lt overWrite gt false lt overWrite gt lt configuration gt lt executions gt lt execution gt lt id gt WServicel lt id gt lt configuration gt lt wsdlFile gt src main resources wsdl xxxx ws wsdl1 lt wsdlFile gt lt configuration gt lt goals gt lt goal gt wsdl2code lt goal gt lt goals gt lt execution gt lt execution gt lt id gt WService2 lt id gt lt configuration gt lt wsdlFile gt src main resources wsdl yyyy_ws wsdl1 lt wsdlFile gt lt configuration gt lt goals gt lt goal gt wsdl2code lt goal gt lt goals gt lt execution gt lt executions gt lt plugin gt kkk k kkk 7 de 14 a Agencia de ic Inform tica y Com
10. elacionandolos con nombres de paquete para generar en estas ubicaciones los datos asociados ace unwrap Desempaqueta los par metros de entrada y Por defecto true salida de los m todos del webservice namespaceToPackages Lista de Namespaces del fichero WSDL Por defecto todas las clases se generan en el mismo paquete del cliente a cada Namespace del servicio web Una vez que este plugin est configurado se puede pasar a la generaci n de las clases clientes del servicio web 4 GENERACION DEL CLIENTE DEL SERVICIO WEB La generaci n a partir del plugin atlas wsdl2code maven plugin se basa en el documento wsdl para generar el cliente A continuaci n de muestra un ejemplo de generaci n para el servicio OptiwsService La configuraci n del plugin es pom xml lt l Plugin para invocador de servicios de negocio Descomentar si se desea utilizar esta caracteristica lt plugin gt lt groupId gt atlasfrm lt groupId gt lt artifactid gt atlasfrm clientews wsdl2code maven plugin lt artifactld gt lt version gt fatlasfrm clientews wsdl2code plugin version lt version gt lt configuration gt lt wsdlFile gt src main resources wsdl opti_ws wsdl lt wsdlFile gt lt packageName gt atlasfrm samples ws client lt packageName gt lt serviceNameAsPackage gt true lt serviceNameAsPackage gt lt overWrite gt false lt overWrite gt lt configuration gt lt executions gt lt execution gt lt goals gt lt goa
11. l gt wsdl12code lt goal gt lt goals gt lt execution gt lt executions gt lt plugin gt gt KAR HRK 9 de 14 dd Agencia de ic Inform tica y Comunicaciones de la Comunidad de Madrid Framework Atlas Servicio de Invocaci n de Servicios A continuaci n se muestra un ejemplo de los ficheros generados para el servicio OptiwsService Clases del cliente generadas en src main java e Paquete base atlasfrm samples ws client e Nombre del Servicio OptiwsService e Nombre de servicio como paquete Si e Interfaz del servicio OptiwsService java e Implementaci n del cliente OptiwsServiceStub java e Mapeo de datos CodigoDeclaracion2 java CodigoDeclaracion2Response java ExtensionMapper java 5 08 src mainfjava H S atlasfrm samples dao EH atlasfrm samples domain H S atlasfrm samples jsf EH atlasfrm samples services atlasfrm samples services facade G atlasfrm samples ws dient optiwsservice Y CodigoDedaracion2 java D CodigoDedaracion2Response java J ExtensionMapper java Li E E l D D J OptiwsService java J OptiwsServiceStub java E Configuraci n de Spring generada en src main resources e Configuraci n de Spring applicationContext OptiwsService xml B E srcfmainfresources a conf application properties X applicationContext dao xml X applicationContext database xml X applicationContext general xml X applicati
12. ls gt lt goal gt wsdl2code lt goal gt lt goals gt lt execution gt lt executions gt lt plugin gt Si se ha partido de uno de los arquetipos de Atlas el plugin se encuentra comentado en el fichero pom xml del arquetipo s lo ser necesario descomentarlo Seg n la configuraci n anterior a partir del fichero xxxx_ws wsdl se generar n las clases cliente del servicio xxxx_ws en el directorio src main java en el paquete xxxx ws client xxxxservice suponiendo que XxxxService sea el nombre del servicio Tambi n se generar un fichero applicationContext XxxxService xml en el directorio src main resources para que el cliente est dado de alta en el contexto de Spring Puede ser necesario incluir manualmente en los configLocations del fichero web xml este nuevo archivo de definiciones AHI kkk 6de 14 dd Agencia de de o Framework Atlas Te Inform tica y Comunicaciones a de la Comunidad de Madrid Servicio de Invocaci n de Servicios Adem s se generar n los test unitarios del servicio en el directorio src test java en el mismo paquete en que se han generado las clases del cliente El test unitario contendr el fichero de definiciones de Spring creado para el servicio 3 2 2 Genearci n de m ltiples clientes de servicio web En caso de tener que generar varios clientes de servicio web la estructura de configuraci n del plugin es diferente a la mostrada en el apartado anterior En este caso d
13. onContext security hostPolitica xml IX applicationContext services xml X applicationContext webservices xml X politicaDemo xml X politicaProhibido xml queries properties Clases de test generadas en src test java e Test unitario OptiwsServiceTest java B E src test java S S atlasfrm samples ws dient optiwsservice D OptiwsServiceTest java Una vez generadas las clases del cliente el fichero de Spring y el test unitario habr que editar este ltimo para proporcionar datos para las llamadas al servicio web Si no se modifica el fichero de test para a adir estos datos el test unitario fallar En cada m todo de test en que sea necesario aportar datos para hacer la llamada se generar un comentario como el siguiente para indicar el sitio donde introducir estos XK AA 10 de 14 kk e 11 TETA Agencia de Framework Atlas ic Inform tica y Comunicaciones n p K de la Comunidad de Madrid Servicio de Invocaci n de Servicios TestCase java TODO Rellenar aqui los valores de XXXXXXXXXXXXXX El test unitario no ejecutara correctamente hasta que no se rellenen valores correctos 5 USO DEL INVOCADOR DE SERVICIOS En este apartado se demostrar el uso del cliente generado Se utilizar como ejemplo el cliente del servicio OptiwsService generado en apartados anteriores 5 1 Parametrizaci n del endpoint La primera modificaci n que habr que hacer al c digo generado ser p
14. row new ServiceException Error obteniendo c digo e 13 de 14 kkk k kkk fi Agencia de Framework Atlas ic Inform tica y Comunicaciones de la Comunidad de Madrid Servicio de Invocaci n de Servicios 6 ENLACES RELACIONADOS Producto URL Axis2 http ws apache org axis2 Documentaci n online del plugin axis2 http ws apache org axis2 tools 1_4 maven plugins maven wsdl2code maven plugin wsdl2code plugin html AH AA ARA 14 de 14
15. rsion lt version gt lt type gt pom lt type gt lt dependency gt AAA kkk 5 de 14 ERAS Agencia de o Framework Atlas ic Inform tica y Comunicaciones e e e de la Comunidad de Madrid Servicio de Invocaci n de Servicios 3 2 Instalaci n y configuraci n del plugin de Maven atlastrm clientews wsdl2code maven plugin Dentro de la secci n de plugins del fichero pom xml de nuestro proyecto es necesario incluir el plugin de Maven atlasfrm clientews wsdl2code maven plugin que es una extensi n del plugin axis2 wsdl2code maven plugin Este plugin generar tanto las clases de cliente del webservice como las clases de tests para las pruebas contra dicho servicio 3 2 1 Generaci n de un cliente de servicio web A continuaci n se muestra un ejemplo de configuraci n del plugin pom xml lt l Plugin para invocador de servicios de negocio Descomentar si se desea utilizar esta caracteristica gt lt plugin gt lt groupId gt atlasfrm lt groupId gt lt artifactlid gt atlasfrm clientews wsdl2code maven plugin lt artifactld gt lt version gt fatlasfrm clientews wsdl2code plugin version lt version gt lt configuration gt lt wsd1File gt src main resources wsdl xxxx_ws wsdl lt wsdlFile gt lt packageName gt xxXX ws client lt packageName gt lt serviceNameAsPackage gt true lt serviceNameAsPackage gt lt overWrite gt false lt overWrite gt lt configuration gt lt executions gt lt execution gt lt goa
16. unicaciones de la Comunidad de Madrid Framework Atlas Servicio de Invocaci n de Servicios 3 2 3 Par metros de configuraci n del plugin Los par metros que se pueden configurar en este plugin son adem s de los propios del plugin wsdl2code maven plugin y que podemos encontrar descrita en la siguiente url http ws apache org axis2 tools 1_4 maven lugins maven wsdl2code plugin html los incluidos en la siguiente tabla Se incluyen tambi n los m s relevantes y o los que han variado con respecto al original cambia su valor o su valor por defecto Propiedad Descripci n Valor wsdlFile Esta etiqueta indica la ruta dentro del proyecto al Ej fichero de descripci n del servicio web del que se sraimairiresourcesiwsdihooa va a generar el cliente _ws wsdl Por defecto src main resources service ws dl packageName Nombre del paquete base donde se generar n Ej xxxx ws client las clases java del cliente de servicio web en src main java serviceNameAsPackage Si es true se a adir el nombre del servicio como paquete al final de packageName El nombre del servicio se modificar para cumplir la normativa de nomenclatura de paquetes Por defecto true overWrite Si es false se comprueba si ya existe el fichero y en caso afirmativo no se generar de nuevo Se recomienda siempre este valor para que los ficheros se generen solo una vez y no se pierdan modificaciones manuales en las clases genera
Download Pdf Manuals
Related Search