Index

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

File to write the current Wrapper status to. This property is not set by default.

This property has no use for most applications. It can be useful to external applications which need to monitor the Wrapper's state however.

If this property is set, a file containing the latest status of the Wrapper process will be written to the specified location when the process is launched and then whenever the internal status changes. The file will be deleted when the Wrapper process has terminated.

Example: 
wrapper.statusfile=./myapp.status

NOTE

The Wrapper needs to be able to open and then write to this file whenever its status is changed. The Wrapper does include code which allows for the file being briefly locked by an external process. However, the Wrapper will fail with a warning in the log if the file remains locked for more that 1 second. This will not affect the operation of the Wrapper.

Status Indication:

The file is formatted as a one line text file with a single token indicating the current Wrapper status.

Possible values include:

  • STARTING :

    The Wrapper is still starting. It will remain in this state until the first Java process has completed its startup, or the Wrapper begins to shut down.

  • STARTED :

    The Wrapper is started. It will remain in this state until the Wrapper begins to shut down or is paused.

  • PAUSING :

    The Wrapper is in the process of pausing the JVM, transitioning from the STARTED to PAUSED state.

  • PAUSED :

    The Wrapper is paused. It will remain in this state until the Wrapper is resumed or shut down. See wrapper.pausable property for more information.

  • RESUMING :

    The Wrapper is in the process of resuming the JVM, transitioning from the PAUSED to STARTED state.

  • STOPPING :

    The Wrapper has begin to shutdown. It will remain in this state until the Java process is completely shut down.

  • STOPPED :

    The Wrapper is ready to exit. This state only exists immediately before the Wrapper process terminates.

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.statusfile.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.statusfile.group=jenkins

wrapper.statusfile.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.statusfile.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.