Index

wrapper.anchorfile
Compatibility :3.1.1
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.

Causes the Wrapper to create an anchor file on startup.

The Wrapper will monitor the file and then shutdown when it is deleted. The Wrapper can still be shutdown by normal methods. If the anchor file still exists when the Wrapper shuts down, it will be deleted automatically.

This property is not set by default. Common values are ./myapp.anchor or /var/run/myapp.anchor.

Example: 
wrapper.anchorfile=wrapper.anchor

INFO

While the property is supported on all platforms, it is most commonly used in combination with the wrapper.ignore_signals property on UNIX systems. In such cases, rather than setting either of these properties manually, it is suggested that the IGNORE_SIGNALS property be uncommented in the shell script that is shipped with the Wrapper. See the wrapper.ignore_signals property for further details.

NOTE

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

wrapper.anchorfile.poll_interval
Compatibility :3.5.31
Editions :Professional EditionStandard EditionCommunity Edition
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

The interval at which the existence of the anchor file is tested can be controlled using the wrapper.anchorfile.poll_interval property. The default value is "5 seconds", with valid values in the range of "1" to "3600" seconds".

Example: 
wrapper.anchorfile.poll_interval=5

NOTE

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

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

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

Example: 
wrapper.anchorfile.group=jenkins

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

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

Example: 
wrapper.anchorfile.umask=0022

wrapper.anchor.poll_interval
Compatibility :3.1.1 (Deprecated as of 3.5.31)
Editions :Professional EditionStandard EditionCommunity Edition
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

WARNING

Use of this property has been deprecated as of Wrapper version 3.5.31 in favor of the wrapper.anchorfile.poll_interval property.

The interval at which the existence of the anchor file is tested can be controlled using the wrapper.anchor.poll_interval property. The default value is "5 seconds", with valid values in the range of "1" to "3600" seconds".

Example: 
wrapper.anchor.poll_interval=5

NOTE

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

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.

Reference: Signal
  • wrapper.anchorfile (3.1.1)

    Sets the path to an anchor file created on startup.

  • wrapper.ignore_signals (3.0.5)

    Controls whether or not the Wrapper should ignore system signals.

  • wrapper.signal.mode.hup (3.2.2)

    Configures the action to take place whenever HUP signals are received.

  • wrapper.signal.mode.usr1 (3.2.4)

    Configures the action to take place whenever USR1 signals are received.

  • wrapper.signal.mode.usr2 (3.2.4)

    Configures the action to take place whenever USR2 signals are received.