Index

wrapper.lockfile
Compatibility :3.2.0
Editions :Professional EditionStandard EditionCommunity Edition
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

WARNING

DO NOT modify any of these parameters unless you have read this property description. Incorrect settings can cause the Wrapper to fail to operate as expected.

Lock file containing the Wrapper's process ID. This property is not set by default.

If this property is set, a file containing the pid of the Wrapper process will be written to the specified location when the process is launched. The file will be deleted when the Wrapper process has terminated.

A common value is /var/lock/subsys/myapp.

Example: 
wrapper.lockfile=/var/lock/subsys/myapp

NOTE

If a second instance of the Wrapper is started, the lock file of the first instance will be overwritten by the second instance. This is done to avoid problems with stale lock files preventing the Wrapper from starting.

On Linux/UNIX platforms, the shell script (sh) which is shipped with the Wrapper will prevent multiple copies of the Wrapper from running for the same application. It is possible to run multiple copies of the Wrapper on the same machine if some of Wrapper are each being used to launch a different application.

In most cases, users will not need to set this property themselves. The UNIX shell script (sh) which is shipped with the Wrapper sets this property from the command line and then makes use of the lock file in future invocations of the script. See the App.sh.in file in the src/bin directory for an example (on older Wrapper versions, this file was named 'sh.script.in').

The property is also available in the Windows version.

NOTE

If the specified file can not be written for any reason on startup, a warning message will be logged but the Wrapper will continue to start up.

NOTE

Changes to the value of this property will not have any affect on the Wrapper if the configuration is reloaded. The Wrapper must be restarted for changes to take effect.

wrapper.lockfile.group
Compatibility :3.5.38
Editions :Professional EditionStandard EditionCommunity Edition
Platforms :Windows (Not Supported)Mac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

You can set "group" for this file. See the wrapper.*.group property.

Example: 
wrapper.lockfile.group=jenkins

wrapper.lockfile.umask
Compatibility :3.2.0
Editions :Professional EditionStandard EditionCommunity Edition
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

You can set "umask" on this file. See the wrapper.*.umask property.

Example: 
wrapper.lockfile.umask=0022

Reference: PID, ID, Status file
  • wrapper.anchorfile (3.1.1)

    Sets the path to an anchor file created on startup.

  • wrapper.java.pidfile (3.0.5)

    Sets the path to a file where the PID of the Java process will be written.

  • wrapper.java.idfile (3.2.0)

    Sets the path to a file where the current Java ID generated by the Wrapper will be written.

  • wrapper.java.statusfile (3.2.0)

    Sets the path to a file where the current status of the JVM will be written.

  • wrapper.pidfile (Usage changed in 3.0.5)

    Sets the path to a file where the PID of the Wrapper process will be written.

  • wrapper.lockfile (3.2.0)

    Configures a lock file containing the Wrapper's process ID.

  • wrapper.statusfile (3.2.0)

    Sets the path to a file where the current Wrapper status will be written.

  • wrapper.*.group (3.5.38)

    Specifies the group to assign when creating certain files.

  • wrapper.*.umask (3.2.0)

    Specifies the permissions for certain files created by the Wrapper.