wrapper.working.dir

Compatibilidad :3.1.0
Ediciones :Edición ProfesionaEdición EstándarEdición de la Comunidad
Plataformas :WindowsMac OSXLinuxAlpine LinuxFreeBSDSolarisIBM z/Linux

ADVERTENCIA

NO modifique ninguno de estos parámetros a menos que haya leído esta descripción de la propiedad. Una configuración incorrecta puede hacer que el Wrapper no funcione como se espera. Se ahorrará mucho tiempo leyendo esta página ANTES de experimentar con esta propiedad.

Descripción general de cómo funciona el directorio de trabajo

Cuando se inicia el Wrapper, se asegura cuidadosamente de que el directorio de trabajo se encuentre en un estado conocido y constante. Esto ayuda a garantizar que no habrá problemas relacionados con las rutas causados por un usuario que inicie el Wrapper desde distintas ubicaciones.

En todas las plataformas, el Wrapper forzará su directorio de trabajo al directorio donde se encuentra su binario inmediatamente al iniciar. Esto es fundamental porque los procesos son lanzados por su sistema operativo padre con el mismo directorio de trabajo que su proceso padre.

Esto significa que el directorio de trabajo sería diferente en cada uno de los tres comandos siguientes: bin\wrapper.exe, .\wrapper.exe, ..\bin\wrapper.exe. Al ejecutarse como servicio de Windows, el directorio de trabajo se establecería en el directorio Windows system32.

Esta inconsistencia en el directorio de trabajo haría imposible utilizar rutas relativas dentro del archivo de configuración del Wrapper.

Ruta absoluta:
wrapper.logfile=C:\Program Files\myapp\logs\wrapper.log

Observe cómo una ruta absoluta debe establecerse en una ubicación que es única para cada instalación. Esto significa que se requeriría un instalador para la aplicación, y que el instalador tendría que modificar los archivos de configuración. Si el usuario alguna vez mueve la aplicación en su disco duro, la configuración se rompería y dejaría de funcionar.

Ruta relativa:
wrapper.logfile=../logs/wrapper.log

Las rutas relativas, por otro lado, son muy útiles. Funcionarán sin importar dónde se instale la aplicación. Las rutas también se pueden definir usando barras inclinadas de modo que el mismo archivo de configuración funcione tanto en Windows como en UNIX sin modificaciones. La configuración también funcionará correctamente incluso si el usuario mueve toda la aplicación a otra ubicación o unidad.

Uso flexible de "wrapper.working.dir":

Sin embargo, hay ocasiones en las que tener el directorio de trabajo establecido en la ubicación del binario del Wrapper hace imposible ejecutar algunas aplicaciones de forma limpia. Un ejemplo es una aplicación que espera que el directorio de trabajo esté en la raíz del sistema de archivos. La única forma de ejecutar dicha aplicación bajo el Wrapper sería colocar el binario y los scripts del Wrapper en el directorio raíz. Algo que la mayoría de los administradores de sistemas no desearían hacer.

Para permitir estos casos excepcionales, se añadió la propiedad wrapper.working.dir. Es muy importante comprender exactamente cómo funciona esta propiedad para evitar problemas.

1. Ruta relativa al binario del Wrapper:

La propiedad wrapper.working.dir se puede especificar ya sea en el archivo de configuración "wrapper.conf" o como un parámetro del binario del Wrapper. Sin embargo, la propiedad no entra en vigor hasta DESPUÉS de que el archivo de configuración del Wrapper se haya cargado por completo. Esto significa que la ubicación del archivo wrapper.conf y de cualquier archivo de inclusión (estilo en cascada) referenciado en él aún debe referenciarse usando ubicaciones relativas al binario del Wrapper. Esto es necesario para asegurar que el archivo de configuración se pueda cargar de forma fiable.

Cualquier variable de entorno referenciada en el archivo de configuración será reemplazada a medida que se cargan las líneas individuales del archivo de configuración. Este es un punto importante si se utilizan para construir valores de ruta dentro de las propiedades.

2. Ruta relativa a un nuevo directorio de trabajo:

Todas las rutas definidas en OTRAS propiedades especificadas ya sea desde la línea de comandos o dentro del archivo wrapper.conf serán entonces relativas a la ubicación especificada por la propiedad wrapper.working.dir.

¿Confundido todavía? Es momento de ver uno o dos ejemplos.

Ejemplo sin configurar wrapper.working.dir

Se usará Windows como ejemplo, pero las cuestiones son las mismas para las plataformas Linux/UNIX.

Estructura de directorios de ejemplo:
C:\myapp\
    bin\
        wrapper.exe
    conf\
        wrapper.conf
        include.conf
    lib\
        wrapper.dll
        wrapper.jar
        myapp.jar
    logs\
        wrapper.log

Sin usar la propiedad wrapper.working.dir, el directorio de trabajo se ubicará en el directorio C:\myapp\bin (la ubicación del binario del Wrapper). El Wrapper se podría iniciar usando el siguiente comando.

Ejemplo de comando: (Inicio del Wrapper)
bin\wrapper.exe -c ../conf/wrapper.conf

Las rutas en el archivo wrapper.conf se configurarían de la siguiente manera. (Tenga en cuenta que este no es un archivo de configuración completo.):

Ejemplo: (archivo de configuración)
@include ../conf/include.conf
wrapper.java.classpath.1=../lib/wrapper.jar
wrapper.java.classpath.2=../lib/myapp.jar
wrapper.java.library.path.1=../lib
wrapper.pidfile=./wrapper.pid
wrapper.java.pidfile=./java.pid
wrapper.logfile=../logs/wrapper.log

Tenga en cuenta que todas las rutas son relativas a la ubicación del archivo binario del Wrapper "wrapper.exe" (C:\myapp\bin).

Ejemplo configurando wrapper.working.dir

Se reutilizará la misma estructura de directorios del ejemplo anterior.

Estructura de directorios de ejemplo:
C:\myapp\
    bin\
        wrapper.exe
    conf\
        wrapper.conf
        include.conf
    lib\
        wrapper.dll
        wrapper.jar
        myapp.jar
    logs\
        wrapper.log

Esta vez la propiedad wrapper.working.dir se establecerá en el directorio padre del directorio bin en el que se encuentra el archivo wrapper.exe. Esta es una ubicación que comúnmente se denomina directorio HOME de la aplicación. C:\myapp en este caso.

La propiedad wrapper.working.dir se puede especificar ya sea en la línea de comandos usada para iniciar el Wrapper, o dentro del archivo wrapper.conf. En cualquiera de los casos, el directorio especificado puede ser absoluto o relativo. En el caso de un directorio relativo, el directorio será relativo a la ubicación del binario del Wrapper. (Como resultado: = C:\myapp)

Ejemplo: (propiedad "wrapper.working.dir") = C:\myapp
wrapper.working.dir=../

Este ejemplo especificará el nuevo directorio de trabajo usando la propiedad wrapper.working.dir dentro del archivo wrapper.conf. Así que en este caso, el comando usado para iniciar el Wrapper no cambia, lo que significa que los archivos por lotes y scripts que se incluyen con el Wrapper se pueden usar sin ninguna modificación.

Ejemplo de comando: (Inicio del Wrapper)
bin\wrapper.exe -c ../conf/wrapper.conf

Cuando se inicia el Wrapper, establece inmediatamente su propio directorio de trabajo en la ubicación del binario del Wrapper (C:\myapp\bin). Luego carga el archivo de configuración "wrapper.conf" y cualquier archivo de inclusión (estilo en cascada) usando ese directorio de trabajo. Después de cargar la configuración, el directorio de trabajo se cambiará a la nueva ubicación especificada por la propiedad wrapper.working.dir (C:\myapp\). Todas las rutas futuras, incluido el inicio de la JVM, se realizarán usando este nuevo directorio de trabajo.

Para este ejemplo, el fragmento de wrapper.conf usado anteriormente se modificará de la siguiente manera:

Ejemplo: (archivo de configuración)
wrapper.working.dir=../
@include ../conf/include.conf
wrapper.java.classpath.1=lib/wrapper.jar
wrapper.java.classpath.2=lib/myapp.jar
wrapper.java.library.path.1=lib
wrapper.pidfile=bin/wrapper.pid
wrapper.java.pidfile=bin/java.pid
wrapper.logfile=logs/wrapper.log

Observe que la ubicación del archivo de inclusión (estilo en cascada) y de la propiedad wrapper.working.dir son ambas relativas a la ubicación del binario del Wrapper (C:\myapp\bin), pero todas las demás rutas ahora son relativas al nuevo directorio de trabajo (C:\myapp\).

La ubicación de la propiedad wrapper.working.dir dentro del archivo wrapper.conf no es importante, ya que no se aplica hasta después de que se haya analizado todo el archivo de configuración.

¿Problemas?

Si encuentra algún problema relacionado con la configuración del Wrapper, lo primero que debe hacerse es habilitar la propiedad wrapper.debug y volver a ejecutar la aplicación. Asegúrese de que la aplicación se pueda ejecutar como aplicación de consola antes de intentar ejecutarla como servicio de Windows o proceso daemon de UNIX.

Ejemplo configurando wrapper.working.dir al directorio inicial

Algunas aplicaciones necesitan la capacidad de establecer su directorio de trabajo en la ubicación desde la que se ejecutó la aplicación. La mayoría de los servidores desean ejecutarse en una ubicación conocida, sin embargo la mayoría de las aplicaciones de línea de comandos necesitan conocer el contexto de dónde se están ejecutando. Un ejemplo simple es el comando mkdir. Necesita saber desde dónde se ejecuta el comando para poder decidir dónde crear el nuevo directorio.

A partir de la versión 3.5.6 del Wrapper, la variable de entorno WRAPPER_INIT_DIR registrará esta ubicación.

En la mayoría de estos casos, simplemente desearía pasar este valor a su aplicación, pero aún así asegurarse de que su aplicación y todos sus archivos de registro se escriban en una ubicación conocida. Esto se puede hacer pasando la ubicación a la JVM en una propiedad del sistema.

Ejemplo del archivo de configuración del Wrapper :
wrapper.java.additional.1=-myinit.working.dir=%WRAPPER_INIT_DIR%
Ejemplo de código Java:
String s = System.getProperty("myinit.working.dir");
File f = new File(s, "test1/myout.txt");

Si, sin embargo, realmente desea establecer el directorio del Wrapper y de su aplicación en la ubicación actual, esto se puede manejar estableciendo el directorio de trabajo en la ubicación del directorio inicial. Tenga en cuenta que lo más probable es que desee establecer la ubicación de cualquier archivo de registro, archivo PID, etc. en una ruta absoluta para asegurarse de que siempre se puedan encontrar. El archivo de configuración del Wrapper siempre se cargará de forma relativa a la ubicación del binario del Wrapper.

Ejemplo de la propiedad "wrapper.working.dir" :
wrapper.working.dir=%WRAPPER_INIT_DIR%

Ejemplo usando variables de entorno

Las variables de entorno se describen con más detalle en la página Trabajar con variables de entorno. Aquí cubriremos algunos de los temas relacionados directamente con los directorios de trabajo.

El Wrapper establece 2 variables de entorno que están asociadas directamente con el directorio de trabajo.

  • La variable WRAPPER_BIN_DIR (Desde la ver. 3.3.0) siempre se establecerá en la ubicación del binario del Wrapper al iniciar. Se puede usar como punto de referencia más adelante en el archivo de configuración incluso si se modifica el directorio de trabajo.

  • La variable WRAPPER_WORKING_DIR (Desde la ver. 3.3.0) es un poco confusa y no resulta realmente útil cuando se referencia desde dentro del archivo de configuración del Wrapper. Siempre se establece en el directorio de trabajo actual, y se establecerá en el valor especificado con la propiedad wrapper.working.dir. Pero cualquier referencia a la variable en el archivo de configuración será reemplazada a medida que se carga el archivo de configuración. Recuerde que en ese momento, el directorio de trabajo aún está establecido en la ubicación del binario del Wrapper. Esta variable de entorno solo es útil dentro de la JVM y sus procesos hijos cuando solicitan la variable de entorno a nivel del sistema.

También es posible que los usuarios definan sus propias variables de entorno dentro del archivo de configuración del Wrapper. Estas se establecen en el entorno a medida que se analizan. Debido a esto, se pueden hacer algunas cosas ingeniosas. En el siguiente ejemplo, crearemos una variable MYAPP_HOME y luego no solo estableceremos el directorio de trabajo, sino que también la usaremos en otras propiedades. Tenga en cuenta que la variable de entorno también se puede usar al cargar los archivos de inclusión (estilo en cascada).

Ejemplo del archivo de configuración :
set.MYAPP_HOME=c:\myapp\
wrapper.working.dir=%MYAPP_HOME%
@include %MYAPP_HOME%/conf/include.conf
wrapper.java.classpath.1=%MYAPP_HOME%/lib/wrapper.jar
wrapper.java.classpath.2=%MYAPP_HOME%/lib/myapp.jar
wrapper.java.library.path.1=%MYAPP_HOME%/lib
wrapper.pidfile=%MYAPP_HOME%/bin/wrapper.pid
wrapper.java.pidfile=%MYAPP_HOME%/bin/java.pid
wrapper.logfile=%MYAPP_HOME%/logs/wrapper.log

Este método se puede usar si el wrapper.exe necesita colocarse en una ubicación fuera de la estructura de directorios de la aplicación. Si es un comando de todo el sistema, por ejemplo.

NOTA

Los cambios en el valor de esta propiedad no tendrán ningún efecto en el Wrapper si se recarga la configuración. El Wrapper debe reiniciarse para que los cambios surtan efecto.

Referencia: Librería