La aplicación de activación es una aplicación Java que administra artefactos J2EE y componentes GBean en el servidor Geronimo. Si Geronimo esta en ejecución, se conectará al servidor y ejecutará su acción a través el servicio de activación del servidor. Si no puede encontrar un servidor en ejecución, lanzará un error indicando que no se pudo conectar al servidor ó el servidor no esta disponible.

La herramienta de activación puede iniciarse mediante el comando java -jar para invocar la clase principal en <geronimo_home>/bin/deployer.jar.

Típicamente, la herramienta de activación se inicia con el uso del script deploy, pero también puedes ejecutarla con el inicio de una máquina virtual Java, usando la siguiente sintaxis:

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 del comando que especifica la acción a ser ejecutada, y <opciones_del_comando> son opciones únicas del comando especificado.

Opciones generales

Esta sección enlista toda opción general disponible 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 herramienta de activación debe contactar al servidor. Si no se establece, la herramienta intentará contactar al servidor usando al puerto estándar en localhost. El identificador debe tener la siguiente forma:
  deployer:geronimo:jmx:rmi:///jndi/rmi:[//host[:puerto]]/JMXConnector
  donde <host> se debe sustituir con el nombre del host ó la dirección TCP/IP donde se encuentra el servidor, y <puerto> se reemplaza con el número de puerto en donde el servidor se encuentra en ejecución. Si no se especifican, localhost y el puerto predeterminado serán los valores usados.

• --host <host>
  Donde <host> es el nombre del servidor al cual intentarás activar una aplicación ó recurso. Esta opción te permite activar recursos y aplicaciones en un servidor remoto. Este parámetro es opcional y el valor predeterminado es localhost.

• --port <puerto>
  Donde <puerto> es el puerto del servidor remoto al cual deseas activar la aplicación ó recurso. Este parámetro es opcional y el valor predeterminado es 1099.

• --driver <directorio_del_controlador>
  Donde <directorio_del_controlador> es el directorio en donde se encuentra el JAR controlador, en caso de que desearas usar esta herramienta con un servidor distinto a Geronimo. Actualmente, valores manifest de Class-Path en dicho JAR, son ignorados.

• --user <nombre_de_usuario>
  Donde <nombre_de_usuario> es el nombre de usuario con permisos administrativos 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 no se especifica, la herramienta intentará ejecutar al comando sin contraseña, pero si el intento falla, solicitará el ingreso de la contraseña.

• --syserr <elección>
  Donde <elección> puede ser true (verdadero) ó false (falso). Si no se especifica, se asume el valor false. Especifica true cuando desees que se haga bitácora de errores, en el dispositivo syserr.

• --verbose <elección>
  Donde <elección> puede ser true (verdadero) ó false (falso). Si no se especifica, se asume el valor 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 típicos
  • deploy
  • login
  • redeploy
  • start
  • stop
  • undeploy
• Otros comandos
  • distribute
  • list-modules
  • list-targets
• Geronimo Plugins
  • install-plugin
  • search-plugins

De forma adicional, puedes usar help para obtener mayor detalle de algún comando, la sintaxis debe ser la siguiente:

java -jar deployer.jar help <comandos>

Regresar a la sección superior

Deploy

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 suelen ser --user y --password. Como novedad en esta versión, la opción --inPlace te permite activar una aplicación sin copiarla (como parte del proceso de activación) al repositorio Geronimo. En otras palabras, puedes tener una aplicación *en ejecución* en Geronimo, pero esa aplicación puede estar en cualquier ubicación del sistema de archivos.

El <módulo> especifica al archivo de aplicación y su ubicación. El <plan_de_activación> especifica el nombre de archivo y ubicación del XML que contenga al plan de activación. En ocasiones el módulo de aplicación incuye en su paquete al plan de activación, ó la aplicación es tan simple que no requiere plan de activación; en esos casos este parámetro puede ser descartado.

Un archivo de módulo puede ser alguno de los siguientes:

• Archivo EAR, J2EE Enterprise Application Archive
• Archivo WAR, J2EE Web Application Archive
• Archivo JAR, J2EE Enterprise JavaBean Archive
• Archivo RAR, J2EE 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 iniciarse en la siguiente ocasión en que el servidor sea iniciado.

Regresar a la sección superior

Login

Usa al comando login para guardar al nombre de usuario y contraseña de la conexión actual, en el archivo .geronimo-deployer, dentro del directorio casa del usuario. Cuando sea posible, en futuras conexiones al mismo servidor, se intentará usar esa información de autentificación en lugar de solicitarla.

Esta información será guardada por separado, para cada conexión URL, por lo que puedes especificar --url ó --host y/ó --port en la línea de comandos para guardar un acceso (login) a un servidor distinto.

El comando login tiene la sintaxis siguiente:

java -jar deployer.jar --user <nombre_de_usuario> --password <contraseña> login

Entonces, la siguiente ocasión que ejecutes algún comando diferente que requiera nombre de usuario y contraseña, puedes ejecutarlo directamente, por ejemplo:

deploy list-modules

Incluso cuando la información de acceso no se almacena en texto limpio, tampoco es seguro. Si deseas guardar la autentificación de forma segura, deberías cambiar el archivo .geronimo-deployer en tu directorio casa, tal que nadie más pueda leerlo ó escribirlo.

Regresar a la sección superior

Redeploy

Usa al comando redeploy para detener, reemplazar y reiniciar algún módulo que ha sido activado (deployed) antes. El comando redeploy tiene la sintaxis siguiente:

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

Así como el comando deploy, el comando redeploy acepta los siguientes tipos de archivos de módulos:

• Archivo EAR, J2EE Enterprise Application Archive
• Archivo WAR, J2EE Web Application Archive
• Archivo JAR, J2EE Enterprise JavaBean Archive
• Archivo RAR, J2EE Java Resource Archive

Típicamente se especifica tanto al módulo como al plan de activación. Si el módulo contiene al plan ó puede usarse un plan predeterminado, se puede descartar el especificar al plan. Sin embargo, si se especifica algún plan, se descarta al resto de planes. Si el plan hace referencia a algún componente del servidor que ya se encuentre activo en el ambiente del servidor, el módulo es descartado.

Regresar a la sección superior

Start

Usa al comando start para iniciar algún módulo que fue activado previamente. El comando start tiene la sintaxis siguiente:

java -jar deployer.jar <opciones_generales> start <moduleIDs>

Donde <moduleIDs> es una lista de uno ó más módulos (configID) separados por espacio en blanco. La identificación del módulo (ó ConfigID) se define al momento de activación en el plan de activación respectivo, para cada módulo previamente activado.

Regresar a la sección superior

Stop

Usa al comando stop para detener algún módulo en ejecución. El comando stop tiene la sintaxis siguiente:

java -jar deployer.jar <opciones_generales> stop <moduleIDs>

Donde <moduleIDs> es una lista de uno o más módulos (configID) separados por un espacio en blanco. La identificación de módulo (ó ConfigID) se define al momento de activación en el plan de activación respectivo, para cada módulo previamente activado.

Regresar a la sección superior

Undeploy

Usa al comando undeploy para detener y eliminar del servidor a un módulo (estando ó no estando en ejecución) junto con su información de activación. El comando undeploy tiene la sintaxis siguiente:

java -jar deployer.jar <opciones_generales> undeploy <moduleIDs>

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

Regresar a la sección superior

Distribute

Usa 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>}}*

Al igual que el comando deploy, <módulo> especifica al archivo de la aplicación junto con su ubicación. El <plan_de_activación> especifica el nombre de archivo y ubicación del XML que contiene al plan de activación. Algunas veces el plan de aplicación es incluido en el paquete de la aplicación, ó la aplicación es tan sencilla que no requiere algún plan de activación; en esos casos este parámetro puede ser descartado.

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

• Archivo EAR, J2EE Enterprise Application Archive
• Archivo WAR, J2EE Web Application Archive
• Archivo JAR, J2EE Enterprise JavaBean Archive
• Archivo RAR, J2EE Java Resource Archive

Regresar a la sección superior

List-modules

Usa al comando list-modules para enlistar a todo módulo disponible en el servidor; nota que para invocar a este comando, el servidor debe estar 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 no se indica otra opción. Causará que enliste a todo módulo disponible
• --started : esta opción enlistará sólo los módulos que estén en ejecución.
• --stopped : esta opción enlistará sólo los módulos que no estén en ejecución.

Regresar a la sección superior

List-targets

Usa al comando list-targets para enlistar los objetivos que conoce 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 (configuration store) es un objetivo separado. Geronimo aún no soporta clusters como objetivos.

Regresar a la sección superior

Install-plugin

Usa al comando install-plugin para instalar algún plugin Geronimo previamente exportado de algún servidor Geronimo ó descargado de un repositorio. Un plugin Geronimo puede ser una aplicación, una configuración como data sources y controladores ó una combinación. El comando install-plugin tiene la sintaxis siguiente:

java -jar deployer.jar install-plugin <archivo_plugin>

Regresar a la sección superior

Search-plugins

Usa al comando search-plugins para enlistar a todo plugin Geronimo disponible en algún repositorio Maven. El comando search-plugins tiene la sintaxis siguiente:

java -jar deployer.jar search-plugins <URL_de_repositorio_maven>

Regresar a la sección superior