World Map
Java Service Wrapper is the easiest way to make your product more reliable.
  • Free Trial
  • Buy Now
wrapper.pidfile Property

Index

wrapper.pidfile

Compatibility : 1.0.0
Editions :Professional EditionStandard EditionCommunity Edition
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM 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.

File to write the Wrapper process ID to. 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.

Common values are ./myapp.pid or /var/run/myapp.pid.

Example:
wrapper.pidfile=./myapp.pid

NOTE

If a second instance of the Wrapper is started, the pid file of the first instance will be overwritten by the second instance. This is done to avoid problems with stale pid 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 pid in future invocations of the script. See the sh.script.in file in the src/bin directory for an example.

The property is also available in the Windows version as some users have requested easy access to the pid for use by profiling tools.

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.pidfile.umask

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

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

Example:
wrapper.pidfile.umask=0022

wrapper.pidfile.strict

Compatibility :3.5.14
Editions :Professional EditionStandard EditionCommunity Edition
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

This property will tell the Wrapper to check if the pid file does exists, before it tries to write its pid file. If the pid file already exists, then it means that there is probably already an instance of the Wrapper running. Therefore this instance of the Wrapper will abort the start-up and stop itself. The script is doing a similar check already, but under certain circumstances, when the same Service/Daemon has been launched simultaneously for multiple times, a race-condition might arise.

There might be a small chance that if the Wrapper or the system stops due to a crash then the Wrapper therefore won't have a chance to clean the pid file. The shipped script is cleaning the pid file, but if a user is using a customized/own script or invoking the binary directly, then this would lead the Wrapper from being unable to start. Due to this and in order to avoid any impact on already setup applications, the default value of this property is FALSE.

Example:
wrapper.pidfile.strict=FALSE

Reference: PID, ID, Status file