WS PROXY GENERATOR. Manual de usuario

Transcripción

1 WS PROXY GENERATOR Manual de usuario

2 CONTENIDO Qué es WSProxyGenerator?... 4 Ejecución de la aplicación... 4 Requisitos de software... 4 Ejecución... 4 Release... 4 Proyecto en IDE... 5 Cómo usar WsProxyGenerator?... 6 Ventana Principal... 6 Estructura del WSDL... 7 Vista Previa

3 ÍNDICE DE ILUSTRACIONES Ilustración 1 Versión Release... 4 Ilustración 2 Proyecto WSProxyGenerator en el IDE Eclipse... 5 Ilustración 3 Ventana principal de WSProxyGenerator... 6 Ilustración 4 Mensaje de validación de datos... 7 Ilustración 5 Visualización de estructura inicial del WSDL... 7 Ilustración 6 Menú contextual en nodos de estructura inicial del WSDL... 8 Ilustración 7 Mensaje de confirmación para eliminar operación en la estructura final del WSDL... 8 Ilustración 8 Opciones adicionales de la ventana de Estructura de WSDL... 8 Ilustración 9 Vista previa del cliente proxy

4 Qué es WSProxyGenerator? Es una herramienta CASE (aplicación con Ingeniería de Software Asistida por Computadora) desarrollada para la interpretación de los WSDL que describen los servicios implementados en los proyectos desarrollados para la empresa ST&T Software, Telecommunications and Technology. WSProxyGenerator permite al personal de desarrollo la generación de clientes de forma automática, cumpliendo con los estándares de desarrollo, calidad y documentación de código propuestos por los clientes de la empresa. Ejecución de la aplicación Requisitos de software El usuario sólo requiere tener instalado en su computador el JDK versión 1.8.0_131 Es imprescindible, ya que WSProxyGenerator hace uso de un componente llamado WSImport para la generación de las clases del cliente proxy. Nota: para el caso en que el usuario desee obtener el proyecto desde el repositorio y ejecutarlo desde un IDE, también requiere la instalación de Maven 3.5 para el compilado. Ejecución La ejecución de la herramienta depende del origen, ya sea por la utilización del comprimido que contiene todos los archivos necesarios para su ejecución o por la obtención del código fuente. Release Es un comprimido que contiene todos los archivos necesarios para ejecutar la aplicación. Basta con descomprimir y dar doble clic al archivo WSProxyGenerator-1.0.jar Ilustración 1 Versión Release 4

5 Proyecto en IDE En caso de que el usuario desee obtener el código fuente, debe solicitar al personal encargado el enlace del repositorio SVN y las credenciales para descargar el proyecto desde su entorno de preferencia (Eclipse, Netbeans). Ilustración 2 Proyecto WSProxyGenerator en el IDE Eclipse 5

6 Cómo usar WsProxyGenerator? Ventana Principal Al ejecutar la aplicación aparece un formulario que solicita los siguientes datos de entrada: Nombre Control Oblig. Descripción WSDL Lista Sí desplegable Corresponde a la url del WSDL a interpretar. Almacena las últimas 10 direcciones ingresadas, siempre y cuando el usuario seleccione la opción de Recordar Formulario. El límite (10) puede ser modificado por archivo de propiedades. Directorio Caja da texto Sí Aparece un selector de carpetas para seleccionar el directorio donde se almacenará(n) la(s) clase(s) del cliente proxy generado. Paquete Caja da texto Sí Nombre del paquete que se utilizará en la definición de la(s) clase(s) del cliente proxy generado. Multitag Client Recordar Formulario Casilla de verificación Casilla de verificación No No Indica si se debe habilitar o no el interceptor para las respuestas de los servicios web. Indica si el usuario desea almacenar los últimos datos ingresados para recordatorio en una próxima ejecución de la aplicación. Ilustración 3 Ventana principal de WSProxyGenerator 6

7 Si los datos ingresados no son válidos, se mostrará un mensaje informando el error. Ilustración 4 Mensaje de validación de datos En caso contrario, la aplicación realizará la interpretación del WSDL suministrado y mostrará una nueva ventana con la estructura obtenida. Estructura del WSDL Se utiliza un componente para la organización de servicios con sus respectivas operaciones y parámetros, los cuales se representan a través de nodos en el siguiente árbol. Ilustración 5 Visualización de estructura inicial del WSDL 7

8 Los nodos tienen algunas opciones habilitadas de acuerdo al nivel en el que se encuentran, es decir, a lo que representan, ya sea un servicio, operación o parámetro. Ilustración 6 Menú contextual en nodos de estructura inicial del WSDL El usuario puede editar el nombre del nodo (para el caso de la ilustración anterior, es el nombre de una operación llamada actualizarestadousuario ). También se habilita la edición al dar doble clic en el nodo o utilizar la tecla F2. También es posible eliminar el nodo seleccionado. Esta función sólo aplica para operaciones, ya que no está permitida la eliminación para servicios o parámetros por razones de configuración. Ilustración 7 Mensaje de confirmación para eliminar operación en la estructura final del WSDL Para eliminar, el usuario debe confirmar que desea realizar dicha acción sobre el nodo (operación) seleccionado. La tecla suprimir delete se encuentra habilitada para esta opción. En la parte inferior de esta ventana, se encuentran 3 botones: Volver: devuelve al usuario a la ventana principal. Vista Previa: muestra una ventana de previsualización de clases. Salir: cierra la aplicación. Ilustración 8 Opciones adicionales de la ventana de Estructura de WSDL 8

9 Vista Previa Es la tercera y última ventana de la aplicación, la cual permite previsualizar las clases del cliente proxy generado de acuerdo a la estructura definida en la ventana anterior. Ilustración 9 Vista previa del cliente proxy 9

10 La cantidad de clases generadas por el cliente proxy corresponde a la cantidad de servicios que se encuentren definidos en el WSDL ingresado. Por cada una de estas clases, aparecerá una pestaña con su respectivo nombre y en su interior, una caja de texto con la definición de toda la clase, la cual está sujeta a los cambios que el usuario desee realizar sobre la estructura inicial en la ventana anterior. Los 4 botones de la parte inferior de la ventana permiten: Volver: devuelve al usuario a la ventana de estructura del WSDL. Nuevo proxy: va a la ventana principal para modificar valores y ejecutar un nuevo cliente proxy. Guardar proxy: almacena la(s) clase(s) modificadas en la ventana anterior (estructura del WSDL). Salir: cierra la aplicación. 10

11 WS PROXY GENERATOR Manual de usuario 2017 Gerente de Desarrollo Juan Carlos Lozano Lozano Ingeniero de Desarrollo Juan Sebastián Cruz Mora Ingeniera de Desarrollo Liliana Loaiza Pulgarín 11