La aplicación de activación (deployer application) es una aplicación Java que administra artefactos J2EE y componentes GBean en el servidor Geronimo. Si el servidor está en ejecución, la herramienta se conectará al servidor y ejecutará su acción a través del servicio de activación del servidor (server's deployment service). Si la herramienta no puede encontrar un servidor en ejecución, administrará la configuración que encuentre, en su propio directorio de instalación.

La herramienta de activación se inicia mediante el uso de java -jar para invocar a la clase principal en <geronimo_home>/bin/deployer.jar.

Típicamente, la herramienta de activación es iniciada mediante el script deploy, pero también puedes ejecutar a la aplicación mediante el inicio de una máquina virtual Java, usando la sintaxis siguiente:

java -jar deployer.jar <opciones_generales> <comando> <opciones_del_comando>

donde <opciones_generales> especifican opciones comunes que aplican a todo comando y controlan como se comporta la aplicación, <comando> es el nombre de comando que especifica la acción a ser aplicada, y <opciones_del_comando> son opciones únicas para el comando especificado.

Opciones generales

Esta sección enlista todas las opciones generales disponibles para la herramienta de activación de Geronimo.

• --uri <identificador>
  Donde <identificador> es un Identificador Universal de Recurso (URI, Universal Resource Identifier), que especifica el como la aplicación de activación contactará al servidor. Si esta bandera no se especifica, la herramienta de activación intentará contactar al servidor usando al puerto estándar en localhost. El identificador debe tener la forma siguiente:
  deployer:geronimo:jmx:rmi:///jndi/rmi:[//anfitrión[:puerto]]/JMXConnector
  donde <anfitrión> se reemplaza con el nombre del anfitrión (host) ó la dirección TCP/IP del sistema donde el servidor está en ejecución, y <puerto> es reemplazado con el número de puerto donde el servidor esté escuchando. Si no se especifica, se emplea localhost como anfitrión y el puerto por defecto.
• --driver <ubicación_del_controlador>
  Donde <ubicación_del_controlador> es la ubicación en el sistema de archivos (path), en donde se encuentra el controlador JAR para usar esta herramienta con un servidor distinto de Geronimo. Actualmente, entradas Class-Path en el MANIFEST dentro del JAR, son ignoradas.
• --user <nombre_de_usuario>
  Donde <nombre_de_usuario> es un nombre de usuario que está autorizado a ser un administrador en el servidor. Si el comando requiere autorización, debes usar esta opción.
• --password <contraseña>
  Donde <contraseña> es la contraseña requerida para autenticar al nombre de usuario. Si esta bandera no se especifica, la herramienta de activación intentará ejecutar al comando sin contraseña, pero si ello falla, intentará solicitarte el ingreso de la contraseña.
• --syserr <seleccionar>
  Donde <seleccionar> puede ser true (verdadero) ó false (falso). Si la bandera no se especifica, se asume false. Especifica true cuando desees hacer bitácora de errores en el dispositivo syserr.
• --verbose <seleccionar>
  Donde <seleccionar> puede ser true (verdadero) ó false (falso). Si la bandera no se especifica, se asume false. Especifica true cuando necesites más mensajes para determinar la causa de algún error.

Regresar a la sección superior

Comandos

Los comandos disponibles para la herramienta de activación Geronimo se enlistan a continuación:

• Comandos comunes
  • deploy
  • redeploy
  • start
  • stop
  • undeploy
• Otros comandos
  • distribute
  • list-modules
  • list-targets
  • package

Además, puedes escribir help (ayuda) para mayor detalle en un comando dado; la sintaxis es la siguiente:

java -jar deployer.jar help <comandos>

Regresar a la sección superior

Deploy (Activar)

Usa al comando deploy (activar) para agregar e iniciar un nuevo módulo. El comando deploy tiene la sintaxis siguiente:

{{java -jar deployer.jar <opciones_generales> deploy <módulo> <plan_de_activación>}}

Las <opciones_generales> más comunes deberían ser --user y --password.
El <módulo> especifica al nombre del archivo de aplicación y su ubicación. El <plan_de_activación> especifica al nombre de archivo y ubicación del XML que contiene al plan de activación (deployment plan). En ocasiones, el módulo de la aplicación ya incluye su plan de activación en el paquete, ó la aplicación es tan simple que no requiere algún plan de activación; en dichos casos, el parámetro <plan_de_activación> puede ser omitido.

El archivo del módulo puede ser alguno de los siguientes:

• Archivo de Aplicación Empresarial J2EE (archivo EAR, Enterprise Application Archive)
• Archivo de Aplicación WEB J2EE (archivo WAR, Web Application Archive)
• Archivo JavaBean Empresarial J2EE (archivo JAR, Enterprise JavaBean Archive)
• Archivo Recurso Java J2EE (archivo RAR, Java Resource Archive)

Si el servidor no se encuentra en ejecución al momento de la activación de la aplicación, el módulo será marcado para ser iniciado en la siguiente ocasión donde el servidor inicie.

Regresar a la sección superior

Redeploy _(Reactivación)_

Emplea al comando redeploy _(reactivación)_ para detener, reemplazar y reiniciar un módulo que ya había sido activado previamente. El comando redeploy tiene la sintaxis siguiente:

{{java -jar deployer.jar <opciones_generales> redeploy <módulo> <plan_de_activación>}}

Así como el comando de activación, el comando de reactivación acepta los siguientes tipos de archivo del módulo:

• Archivo de Aplicación Empresarial J2EE (archivo EAR, Enterprise Application Archive)
• Archivo de Aplicación WEB J2EE (archivo WAR, Web Application Archive)
• Archivo JavaBean Empresarial J2EE (archivo JAR, Enterprise JavaBean Archive)
• Archivo Recurso Java J2EE (archivo RAR, Java Resource Archive)

Comúnmente, se especifica tanto un módulo como un plan. Si el módulo contiene un plan ó si un plan por defecto puede ser usado, es válido omitir la opción del plan. Sin embargo, si en este caso se especifica algún plan, se antepone a otros planes. Si el plan hace referencias a un componente del servidor que ya ha sido activado en el ambiente del servidor, se omite a dicho módulo.

Regresar a la sección superior

Start (Iniciar)

Emplea al comando start para iniciar un módulo previamente activado. El comando start tiene la sintaxis siguiente:

{{java -jar deployer.jar <opciones_generales> start <IDs_de_módulos>}}

Donde <IDs_de_módulos> es una lista de uno o más módulos (ConfigID) separados por espacio en blanco. La identificación del módulo (ó ConfigID) es definida al momento de activación, en el plan de activación propio de cada módulo previamente activado.

Regresar a la sección superior

Stop (Detener)

Emplea al comando stop para detener un módulo en ejecución. El comando stop tiene la sintaxis siguiente:

{{java -jar deployer.jar <opciones_generales> stop <IDs_de_módulos>}}

Donde <IDs_de_módulos> es una lista de uno o más módulos (ConfigID) separados por espacio en blanco. La identificación del módulo (ó ConfigID) es definida al momento de activación, en el plan de activación propio de cada módulo previamente activado.

Regresar a la sección superior

Undeploy (Desactivar)

Emplea al comando undeploy para detener y eliminar del servidor, un módulo (estando o no, en ejecución) así como su información de activación. El comando undeploy tiene la sintaxis siguiente:

{{java -jar deployer.jar <opciones_generales> undeploy <IDs_de_módulos>}}

Donde <IDs_de_módulos> es una lista de uno o más módulos (ConfigID) separados por espacio en blanco. La identificación del módulo (ó ConfigID) es definida al momento de activación, en el plan de activación propio de cada módulo previamente activado.

Regresar a la sección superior

Distribute (Distribuir)

Emplea al comando distribute para agregar un nuevo módulo al servidor. Este comando no inicia al módulo ni lo marca para ser iniciado en el futuro. El comando distribute tiene la sintaxis siguiente:

{{java -jar deployer.jar <opciones_generales> distribute <módulo> <plan_de_activación>}}

Así como el comando deploy, <módulo> especifica al nombre de archivo y su ubicación. El <plan_de_activación> especifica al nombre de archivo y ubicación del XML que contiene al plan de activación. En ocasiones, el módulo de aplicación ya incluye un plan de activación en su paquete ó la aplicación es tan simple que no requiere plan de activación alguno; en dichos casos, el parámetro <plan_de_activación> puede ser omitido.

El archivo del módulo puede ser alguno de los siguientes:

• Archivo de Aplicación Empresarial J2EE (archivo EAR, Enterprise Application Archive)
• Archivo de Aplicación WEB J2EE (archivo WAR, Web Application Archive)
• Archivo JavaBean Empresarial J2EE (archivo JAR, Enterprise JavaBean Archive)
• Archivo Recurso Java J2EE (archivo RAR, Java Resource Archive)

Regresar a la sección superior

List-modules _(Enlistar-módulos)_

Emplea al comando list-modules para enlistar a todo módulo disponible en el servidor; nótese que la ejecución de éste comando requiere que el servidor se encuentre en ejecución. El comando list-modules tiene la sintaxis siguiente:

java -jar deployer.jar <opciones_generales> list-modules [--all|--started|--stopped]

• --all : se usa por defecto, cuando ninguna otra opción se especifica. Se encargará de enlistar a todo módulo disponible.
• --started : esta opción enlistará sólo a los módulos que estén en ejecución.
• --stopped : esta opción enlistará sólo a los módulos que no estén en ejecución.

Regresar a la sección superior

List-targets (Enlistar-destinos)

Emplea al comando list-targets para enlistar a los destinos conocidos para el servidor al cual te has conectado. El comando list-targets tiene la sintaxis siguiente:

java -jar deployer.jar <opciones_generales> list-targets

En el caso de Geronimo, cada almacén de configuración es un destino separado. Al momento, Geronimo aún no soporta clusters como destinos.

Regresar a la sección superior

Package (Paquete)

Emplea al comando package para crear un archivo JAR de configuración en lugar de la instalación en el ambiente del servidor. El comando package tiene la sintaxis siguiente:

{{java -jar deployer.jar <opciones_generales> package [--classPath path] [--mainClass class] [--install] <módulo> <plan_de_activación> fileName}}

El argumento opcional --classPath especifica un Class-Path a incluir en el MANIFEST del JAR. El argumento opcional --mainClass especifica la Main-Class a incluir en el MANIFEST del JAR. La opción --install especifica que la configuración debería ser construida en un JAR y también instalada en la configuración del servidor (de otro modo, es empaquetada, más no instalada). El argumento fileName especifica el JAR a ser creado.

Regresar a la sección superior