FRAMEWORK 2 ARQUITECTURA DE APLICACIONES BATCH

Transcripción

1 FRAMEWORK 2 ARQUITECTURA DE APLICACIONES BATCH Versión 1.1 Área de Aplicaciones Especiales y Arquitectura de Software

2 Hoja de Control Título Manual de usuario de Framework 2 Documento de Referencia NORMATIVA FRAMEWORK 2 Responsable Área de Aplicaciones Especiales y Arquitectura de Software Versión 1.1 Fecha Versión 22/11/2013 Registro de Cambios Versión Causa del Cambio Responsable del Cambio Área de Aplicaciones 0.1 Versión inicial del documento Especiales y Arquitectura de Software Se cambia el formato del documento y se indica que Área de Aplicaciones se elimine el jar seguridad_cm de la entrega a 1.1 Especiales y Arquitectura desarrollo, ya que se utilizará el compartido en el de Software servidor Fecha del Cambio Mayo /11/ de 15

3 Índice 1 INTRODUCCIÓN AUDIENCIA OBJETIVO CONOCIMIENTOS PREVIOS INFORMACIÓN SOBRE LA PLANTILLA CREACIÓN DE UNA APLICACIÓN PARTIENDO DE LA PLANTILLA ESTRUCTURA DE DIRECTORIOS Y ARCHIVOS CONSTRUCCIÓN DEL BATCH Clase Principal Configuración de la aplicación Creación del jar con Eclipse 3.X Ejecución de la aplicación EMPAQUETADO DE LA APLICACIÓN PREGUNTAS MAS FRECUENTES ENLACES RELACIONADOS de 15

4 1 INTRODUCCIÓN La presente guía estable los requisitos que deben de cumplir las aplicaciones batch que se desarrollen para la Comunidad de Madrid con el Framework 2. Este framework es propietario de ICM y se encuentra implementado en la librería Sistemas_mini_2.x. Esta es una versión reducida de la librería Sistemas para aplicaciones que no tienen capa de presentación. 1.1 AUDIENCIA OBJETIVO Este documento está dirigido a desarrolladores de proyectos java para ICM en los que se desee crear una aplicación batch utilizando el Framework CONOCIMIENTOS PREVIOS Las aplicaciones batch que se desarrollen para la Comunidad de Madrid con framework 2 deberán cumplir además los requisitos indicados en la guías: Desarrollos en Java Información General Framework 2 Información General 4 de 15

5 2 INFORMACIÓN SOBRE LA PLANTILLA 2.1 Creación de una aplicación partiendo de la plantilla La plantilla para el desarrollo de este tipo de módulos se llama: fw2_batch_plantilla Esta plantilla está disponible para su descarga en el portal de arquitecturasw con el resto de las plantillas del Framweork 2: Estructura de directorios y archivos <Proyecto>_batch_xxxx java zip desarrollo *.zip *.conf formacion *.conf (formación + asf + otros futuros) mantenimiento *.conf (mantenimiento + asf + otros futuros) prod_internet *.conf (prod_internet + asf + otros futuros) prod_intranet *.conf (prod_intranet + asf + otros futuros) validacion *.conf (validacion + asf + otros futuros) fuentes classes Clases compiladas deploys Estructura de directorios del fichero zip programas jar con las clases propias de la aplicación. jar correspondientes a las librerías utilizadas. Fichero de configuración (todos). procesos *.sh Estructura de directorios necesarios para la ejecución de la aplicación (Por ejemplo: plantillas, reports, images, etc) lib Directorio con las librerías necesarias de compilación en el proyecto 5 de 15

6 src Ficheros java fuentes en sus correspondientes paquetes y el fichero de configuración <Proyecto>_batch_xxxx bean Clases de javabean, estructuras de datos modelo Clases de acceso a base de datos principal Clase de inicio de la aplicación Donde <Proyecto> es el nombre del proyecto de 4 letras y xxxx es un nombre que identifique a este módulo. (Puede ocurrir que haya mas módulos batch en un proyecto.) Framework 2 En el directorio desarrollo hay que crear un zip con todos los ficheros que se encuentran en el directorio deploys, conservando la estructura de directorios. El directorio programas contiene todos los ficheros que son necesarios para la ejecución de la tarea. El directorio procesos contiene la shell de Linux que va a realizar la llamada al código Java. En el caso de que existan otros ficheros como reports o plantillas, se creara una carpeta con estos ficheros a la misma altura de las carpetas programas y procesos. 2.3 Construcción del batch Una vez descargada la plantilla e inportada como proyecto java desde la herramienta de desarrollo Eclipse, deberemos proceder a incorporar la lógica de negocio de nuestro batch. La implementación del código se hará de acuerdo a la normativa ICM para Framework Clase Principal La clase principal de la aplicación, aquella que tiene el método main y que en el fichero Manifest especificamos como Main-Class, debe extender de la clase sistemas.consola.claseprincipal. Se suele llamar Principal. Tiene que implementar el constructor con una cadena como argumento y dentro de este llamar al super. El constructor de la clase ClasePrincipal va a recoger la ruta y el nombre del fichero de configuración, leer la configuración e inicializar la conexión con la base de datos. 6 de 15

7 Después hay que implementar el método main. Dentro de este método hay que realizar los siguientes pasos: Instanciarse a si misma usando el constructor y pasándole como parámetro el nombre de la aplicación. Llamar a la clase o clases que implementen la lógica de la aplicación. Estas clases se encontrarán en el paquete acciones. Estos dos pasos anteriores estarán dentro de un try-catch y en el finally se incluirá una llamada al método finalizar de nuestra clase. Este es un método heredado de ClasePrincipal que se va a encargar de liberar la conexión con la base de datos. package fw2_batch_plantilla.principal; Clase Principal.java import java.io.filenotfoundexception; import sistemas.excepciones.configexception; import fw2_batch_plantilla.acciones.muestradatosempleado; public class Principal extends sistemas.consola.claseprincipal { public Principal(String s) throws FileNotFoundException, ConfigException{ super(s); } public static void main(string[] args) throws FileNotFoundException, ConfigException { Principal p = null; try{ p = new Principal("fw2_batch_plantilla"); //Lanzamos la clase que realizara el proceso principal }finally{ new MuestraDatosEmpleado().mostrarDatos(); // llamadas a la logica de la aplicación } if (p!= null){ p.finalizar(); } } System.exit(0); } 7 de 15

8 La clase Principal es la que contiene el método método main, donde se iniciará el procesamiento del batch Configuración de la aplicación La configuración de la aplicación Batch se realiza modificando el fichero fw2_batch_plantilla.conf de nuestro proyecto (con nomenclatura: <Proyecto>_batch_xxxx.conf). fw2_batch_plantilla.conf ######################################################### # Variables de configuracion general de la aplicacion # ######################################################### aplicacion.usarbd = true ################# # BASE DE DATOS # ################# aplicacion.clasepoolconexiones=sistemas.conexiones.poolconexionesicm bd.driver = oracle.jdbc.driver.oracledriver bd.usuario = XXXXX bd.clave = XXXXX (Clave encriptada) bd.url = jdbc:oracle:thin:@icm21:1521:denivel2 ############## # Trazas # ############## trazas.tipo = BRSLMET trazas.grabarlog = true trazas.ficherolog=/usr/aplic_icm/logs/fw2_batch_plantilla/fw2_batch_pl antilla 8 de 15

9 2.3.3 Creación del jar con Eclipse 3.X El jar debe incluir: Las clases compiladas de la aplicación. Fichero Manifest que le indique el path de las librerías que va a utilizar. Y la clase que servirá de punto de entrada para la aplicación, la clase principal. Manifest-Version: 1.0 Class-Path: sistemas_mini_2_5_5.jar ojdbc6.jar seguridad_cm_1_1.jar Main-Class: ejpl_batch_empleados.principal.principal Para crear el jar desde Eclipse se ha de seleccionar el proyecto, se pulsa botón secundario del ratón y se selecciona la opción Export. Una vez seleccionada esta opción nos aparecerá una pantalla como la siguiente: 9 de 15

10 Después de seleccionar JAR file pulsaremos el botón Next que nos presentará el paso 2 de la creación de un jar. En este paso seleccionaremos el código fuente del proyecto y la opción Export generated class files and resources. Además se seleccionará el directorio donde se guardará [ejpl_batch_empleados].jar. Sería también conveniente marcar las opciones de Compress the contents of the JAR file y Overwrite existing files without warning. 10 de 15

11 Pulsaremos next y pasaremos a la siguiente pantalla donde seleccionaremos las opciones Export class files with compile errors, Export class files with compile warning y Save the description of this JAR in the workspace y pulsaremos el botón Next. 11 de 15

12 En la última pantalla seleccionaremos Use existing manifest from workspace indicando la ruta del fichero MANIFEST.MF de nuestro proyecto. 12 de 15

13 Ahora ya solo queda pulsar en el botón Finish y esperar a que se genere nuestro archivo jar. Cuando se haya acabado de generar el fichero veremos en la ventana Package Explorer que ha aparecido una nueva entrada similar a esta ahora cuando queramos podremos generar de nuevo el jar, sin necesidad de compilar todo el proyecto, simplemente pulsando sobre esta entrada con el botón derecho del ratón y seleccionando la opción Create JAR Ejecución de la aplicación Para ejecutar la aplicación desde Eclipse lo haremos sobre la clase Principal con la opción Run As Application. Nos aparecerá por consola las trazas que va ejecutando. 13 de 15

14 Por otra parte también se genera un fichero de log en una carpeta log dentro de nuestro proyecto. 2.4 Empaquetado de la aplicación En el proceso de compilación además de generarse el batch, se genera el fichero zip con la distribución del proyecto batch. NOTA IMPORTANTE Es necesario eliminar la librería seguridad_cm del entregable, ya que en ejecución se utilizará la librería común del servidor. Para probar la aplicación en desarrollo es suficiente con descomprimir el zip en la carpeta /icm/batch de la máquina de desarrollo icmdesbatch y ejecutar el script de ejecución (es necesario que este fichero tenga permisos de ejecución chmod +x nombre_batch.sh ). El fichero.sh que ejecuta un batch tiene la siguiente forma: Ejemplo de fichero de ejecución del batch nombre_batch.sh export JAVA_HOME=$JAVA_HOME_1_6 (Cambiar el 6 por la versión de JDK que se quiera) export JAVA_OPTIONS=- Djava.ext.dirs=/usr/aplic_ICM/lib:$JAVA_HOME/jre/lib/ext $JAVA_HOME/bin/java $JAVA_OPTIONS -jar nombre_batch.jar $* (Cambiar nombre_batch por el nombre del fichero jar que se desea ejecutar). 14 de 15

15 3 PREGUNTAS MAS FRECUENTES La lista de preguntas frecuentes se encuentra en el portal de arquitectura. 4 ENLACES RELACIONADOS Producto Normativa Framework 2 ICM URL 15 de 15