ATLAS MANUAL DE INTEGRACIÓN Cliente del Servicio de SMS

Transcripción

1 ATLAS MANUAL DE INTEGRACIÓN Cliente del Servicio de SMS Versión 1.0 Arquitectura de Software

2 Hoja de Control Título Documento de Referencia Responsable Servicio de SMS Cliente NORMATIVA ATLAS Arquitectura de Software Versión 1.0 Fecha Versión 14/11/2013 Registro de Cambios Versión Causa del Cambio Responsable del Cambio Fecha Cambio del 1.0 Versión inicial del documento Área de Aplicaciones Especiales y Arquitectura 14/11/2013 de Software 2 de 12

3 Índice 1. INTRODUCCIÓN AUDIENCIA OBJETIVO CONOCIMIENTOS PREVIOS DESCRIPCIÓN INTEGRACIÓN CON MENT_WS_SMS CLIENTE SOLICITUD DE ACCESO LIBRERÍA DE INTEGRACIÓN FW2_UTIL DEPENDENCIAS APIS DE INTEGRACIÓN EJEMPLOS DE UTILIZACIÓN Envío Simple Envío Múltiple ENLACES RELACIONADOS de 12

4 1. INTRODUCCIÓN Para realizar envíos y recepción de mensajes de texto aplicaciones de la Comunidad de Madrid, se ha optado por una solución centralizada que a través de una plataforma de Telefónica (MENTES). Esta plataforma realiza los envíos y registra las recepciones de mensajes de texto de forma independiente, de forma que todos los envíos se centralizan en un único servicio Web, pero las recepciones y el procesado de las mismas se deben implementar de forma específica por cada aplicación siguiendo las instrucciones del documento de Recepción de SMS s. El acceso a esta plataforma esta restringido, solo se podrá interactuar con ella a través de un servicio Web. Este servicio Web solicita un identificador de aplicación para realizar envío de mensajes ya que no ninguna aplicación puede realizar envíos de mensajes sin solicitar previamente acceso a este servicio. Aunque el cliente de dicho servicio se ha implementado en el framework ATLAS, a continuación se detallan los pasos para utilizarlos desde otros Framework como el Framework 2.0 de ICM Audiencia objetivo Este documento está orientado a desarrolladores java que necesiten realizar envios SMS en aplicaciones ICM, utilizando el cliente del servicio web implementado en ATLAS, desde otros frameworks (Framework2, justicia, ) Conocimientos Previos Para un completo entendimiento del documento, el lector deberá tener conocimientos previos sobre las siguientes tecnologías: - Lenguaje de programación Java. - Tecnologias web como Tags, Applets, JSPs, etc. 4 de 12

5 2. DESCRIPCIÓN El cliente del servicio Web de MENTES tiene los métodos necesarios para realizar envíos simples y complejos, es decir, permite enviar un mensaje simple a un télefono simplemente indicando la aplicación, el mensaje y el teléfono de destino, enviar un mensaje a varios teléfonos indicando la aplicación, el mensaje y la lista de teléfonos, así como enviar multiples mensajes a multiples destinos con planificación o sin ella, con confirmación o sin ella. Ante la necesidad de manejar información de planificación, estado de envio, estado de confirmación, asi como la necesidad de obtener un resumen de un envio complejo, se han utilizando una serie de clases definidas especificamente para ello, de esta forma se evita que cada uno gestione esta información como quiera y facilitando la comunicación entre el cliente y el servicio. 3. INTEGRACIÓN CON MENT_WS_SMS CLIENTE En este apartado se describirán todos los elementos necesarios para realizar la integración con el cliente del servicio SMS de Atlas, desde otros frameworks existentes en ICM. Se mostrarán los procedimientos de solicitud de alta en la plataforma MenTes, las librerías necesarias para ejecutar la integración Solicitud de acceso Para la utilización del servicio de ment_ws_sw es necesario que la aplicación desde la que se llama esté dada de alta y autorizada en la platafoma MENTES. Estos datos habrán de solicitarse según sea el entorno al que se quiere acceder. En el entorno de desarrollo las solicitudes se realizarán via incidencia al equipo de Arquitectura en la web: Para el resto de entornos las peticiones deberán dirigirse a Paso a Producción. 5 de 12

6 3.2. Librería de Integración FW2_UTIL La librería fw2_util permite instanciar servicios ATLAS desde otros Frameworks. En este documento se describe cómo invocar al servicio de SMS de ATLAS Dependencias Para el correcto funcionamiento de la comunicación con el Servicio de MenTes, son necesarias las siguientes librerías: Librería activation jar ment_ws_sms_lib jar apache-mime4j-core jar Descripción JavaBeans activation framework Cliente del servicio web Atlas de Mentes Librería de Apache atlasfrm-clientews-lib jar Framework de servicios web de ATLAS atlasfrm-comunes-lib jar Clases comunes de ATLAS sistemas2_5_5.jar Librería de Framework 2 fw2_util-1.1.jar axiom-api jar axiom-dom jar axiom-impl jar axis2-adb jar axis2-kernel jar axis2-metadata jar axis2-transport-http jar axis2-transport-local jar commons-codec-1.5.jar commons-discovery-0.2.jar commons-httpclient-3.1.jar commons-io-2.4.jar commons-lang-2.1.jar commons-logging jar httpcore jar jaxb_icm_1_3.jar Librería para instaciar servicios ATLAS en otros FrameWorks Librería Apache commons Librería Apache commons Librería Apache commons Librería Apache commons Librería Apache commons Librería Apache commons Librería Apache Librería JAXB ICM 6 de 12

7 jaxrpc.jar jstl-1.2.jar log4j jar mail-1.2.jar neethi jar wsdl4j jar xalan jar xercesimpl jar xml-apis-1.0.b2.jar XmlSchema jar Java Standard Tag Library (podría no ser necesaria) Utilidad de Log Librería para gestión de DataHandlers 3.4. APIs de integración Instanciando la Factoría util.services.clientesmsfactory que se provee en la librería fw2_util, podemos utilizar los métodos de la interfaz atlas.sms.client.clientesms: class Class Model «interface» ClienteSMS + enviar(datosenviosms) : String + enviomultiple(string, String, Collection<String>) : String + enviosimple(string, String, String) : String + esenviocorrecto(long, String) : boolean + findbyaplicacionfecha(string, Date, String, String) : Collection<EstadoEnvio> + findbyidpeticion(long, String) : Collection<EstadoEnvio> + finderroneos(long, String) : Collection<EstadoEnvio> + findnoconfirmados(long, String) : Collection<EstadoEnvio> + resumenenvioaplicacionfecha(string, Date, String, String) : Collection<ResumenEnvio> + resumenenvioidpeticion(long, String) : ResumenEnvio Atributo Tipo Descripción Aplicacion String Aplicación desde la que se realiza el envio. CodigoCliente String Código de cliente del envío. Confirmacion String Indicador de si el envio requiere confirmación. DatosSMS Collection<DatosSMS> Información del envio. Planificacion PlanificacionEnvio Información de la planificación del envio. TipoServicio String Tipo de servicio del envío. 7 de 12

8 Metodo enviar(datosenviosms datos) enviomultiple(string aplicacion, String texto, Collection<String> telefonos) enviosimple(string aplicación, String texto, String telefono) esenviocorrecto(long idpeticion, String aplicacion) findbyaplicacionfecha (String aplicacion, Date fechaenvio, String tiposervicio,string codigocentro) findbyidpeticion(long idpeticion, String aplicacion) finderroneos(long idpeticion, String aplicacion) findnoconfirmados(long idpeticion, String aplicacion) resumenenvioaplicacionf echa(string aplicacion, Date fecha,string tiposervicio,string codigocentro) resumenenvioidpeticion (Long idpeticion, String aplicacion) Descripción Función que realiza un envio cuyo contenido se define a traves de un objeto de tipo DatosEnvioSMS devolviendo el identificador asignado a la petición. Función que que realiza el envio del mensaje recibido como parámetro para la aplicación recibida como parámetro a la lista de teléfonos recibida como parámetro, devolviendo el identificador asignado a la petición. Función con la que se realiza un envio desde una aplicación, con el texto y al teléfono todos recibidos como parámetros, devolviendo el identificador asignado a la petición. Función con la que se comprueba el estado de un envio a partir de su identificador y el de la aplicación desde la que se realizó el envío, devolviendo siel envio se ha realizado correctamente o no. Función con la que se optienen todos los envíos realizados desde una aplicación en una fecha concreta. Este método devuelve una colección de EstadoEnvio. Función con la que se obtiene el estado del envio identificado por el id recibido como parámetro.este método devuelve un estadoenvio. Función con la que se obtiene la lista de mensajes erroneos de la petición identificada por el id recibido como parámetro. Este método devuelve una colección de EstadoEnvio. Función con la que se obtiene la lista de mensajes no confirmados de la petición identificada por el id recibido como parámetro. Este método devuelve una colección de EstadoEnvio. Función con la que se obtienen los resumenes de los envios realizados por la aplicación recibida como parámetro, en la fecha recibida como parámetro del tipo de servicio y código de centro tambien recibidos como parámetros. Esta función devuelve una colección de ResumenEnvio. Función con la que se obtiene el resumen de la petición identificada por el id que recibe como parámetro. 8 de 12

9 3.5. Ejemplos de utilización ATENCIÓN Todos los ejemplos mostrados a continuación han sido planteados dentro de una aplicación en el ámbito de FrameWork 2.0. Sin embargo, el código de ejemplo es fácilmente extraible para ser usado en otros frameworks java de desarrollo web. Para Framework 2 se deberán incluír únicamente las librerías (en WEB-INF/lib): ment_ws_sms_lib jar atlasfrm-clientews-lib jar atlasfrm-comunes-lib jar sistemas2_5_5.jar fw2_util-1.1.jar Y tener las referencias a las librerías compartidas del framework2 y de Axis 2 (en el fichero weblogic.xml), ya que el resto de librerías necesarias se encuentran dentro de las compartidas del servidor siguientes:... <library-ref> <library-name>fw2-dependencias-compartidas</library-name> <specification-version>2.5.4</specification-version> <implementation-version>2.5.4</implementation-version> <exact-match>false</exact-match> </library-ref> <library-ref> <library-name>fw2-dependencias-axis2</library-name> <specification-version>1.6.2</specification-version> <implementation-version>1.6.2</implementation-version> <exact-match>false</exact-match> </library-ref>... 9 de 12

10 Envío Simple import atlas.sms.client.clientesms; import util.services.clientesmsfactory;... Ejemplo de utilización en FW2 (java) public String procesar() throws sistemas.framework.excepciones.accionexception { String resultadoenvio = null; try { String endpoint = Config.get("ejpl_cliente_sms.endpoint"); String aplicacion = Config.get("ejpl_cliente_sms.aplicacion"); String telefono = Config.get("ejpl_cliente_sms.telefono"); String mensaje = Config.get("ejpl_cliente_sms.mensaje"); ClienteSMS clientesms = ClienteSMSFactory.getSMSClienteService(endPoint); Trazas.impLog("envioEjemploSMS:" + " \n\t\t\t\t --> aplicacion :" + aplicacion + " \n\t\t\t\t --> mensaje: " + mensaje + " \n\t\t\t\t --> telefono: " + telefono); resultadoenvio = clientesms.enviosimple(aplicacion, mensaje, telefono); } catch (Exception ex) { Trazas.impExc("Error al llamar al cliente de envio sms "); Trazas.imprimeErrorExtendido(ex); throw new AccionException(ex.getMessage()); } request.setattribute("resultadoenvio", resultadoenvio); } return NOMBRE_VISTA; Ejemplo de configuración en FW2 (fichero.conf) ######################################################### # Prueba de envio de Mensajes SMS # ######################################################### ejpl_cliente_sms.endpoint = ejpl_cliente_sms.aplicacion = AIAA ejpl_cliente_sms.telefono = ejpl_cliente_sms.mensaje = Mensaje de prueba cliente sms 10 de 12

11 Envío Múltiple import atlas.sms.client.clientesms; import atlas.sms.domain.datosenviosms; import atlas.sms.domain.datossms; import util.services.clientesmsfactory;... try { Ejemplo de utilización en FW2 (java) ClienteSMS clientesms = ClienteSMSFactory.getSMSClienteService(endPoint); DatosEnvioSMS datosenvio = new DatosEnvioSMS(); DatosSMS datossms = new DatosSMS(); datossms.setmensaje(mensaje); datossms.addtelefono(telefono); datossms.addtelefono(telefono1); List<DatosSMS> datos = new ArrayList<DatosSMS>(); datos.add(datossms); datosenvio.setdatossms(datos); datosenvio.setaplicacion(aplicacion); datosenvio.setconfirmacion(false); Trazas.impLog ("enviomultipledatosenviosmssinconfirmacion:" + " \n\t\t\t\t --> aplicacion :" + aplicacion + " \n\t\t\t\t --> mensaje: " + mensaje + " \n\t\t\t\t --> telefonos: " + listatelefonos); resultadoenvio = clientesms.enviar(datosenvio); Trazas.impLog ("Respuesta: " + resultadoenvio); } catch (Exception ex) { } Trazas.impExc("Error al llamar al cliente de envio sms "); Trazas.imprimeErrorExtendido(ex); throw new AccionException(ex.getMessage()); } request.setattribute("resultadoenvio", resultadoenvio); return NOMBRE_VISTA; 11 de 12

12 4. ENLACES RELACIONADOS Producto Axis2 Manual Cliente SMS Atlas URL (Apartado Integración: Envío SMS) 12 de 12