Index

wrapper.java.statusfile
Compatibility :3.2.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 current Java 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 Java process's state however.

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

Example: 
wrapper.java.statusfile=./myapp.java.status

NOTE

The Wrapper needs to be able to open and then write to this file whenever the Java process status changes. The Wrapper allows for the file to be 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 Java process status.

Possible values include:

  • DOWN_CLEAN :

    The Java process is completely down. This is the state when the Wrapper first starts, as well as after it has been confirmed that the Java process has been terminated. The state must always return to DOWN_CLEAN before the Wrapper itself will be allowed to proceed with its own shutdown.

  • LAUNCH(DELAY) :

    The Wrapper is waiting to launch a new JVM. This is the state when the Wrapper is waiting to launch a new JVM process. It can happen on startup if the wrapper.startup.delay property is set, or during a restart if the wrapper.restart.delay property has a value greater than "0" (zero). If the Wrapper itself is in a state where it is ok to launch a JVM, then the state will change to LAUNCH for startup (first JVM), and RESTART for restarts (second and later JVMs). Otherwise, the state is changed back to DOWN_CLEAN.

  • RESTART :

    The Wrapper is attempting to restart the JVM. If the Wrapper itself is in a state where it is ok to launch a JVM then the state will change to LAUNCH. Otherwise, the state is changed back to DOWN_CLEAN.

  • LAUNCH :

    The Wrapper is ready to launch a new JVM. The state will normally be changed to STARTING. If there were any immediate errors launching the process, the state will change back to DOWN_CLEAN.

  • LAUNCHING :

    The Wrapper is in the process of launching the JVM but the existence of the new Java process has not yet been confirmed. The amount of time that the Wrapper will be allowed to remain in this state is controlled by the wrapper.startup.timeout property. Normally the state will change to LAUNCHED. In the event of a timeout, the state will change to KILLING.

  • LAUNCHED :

    The Wrapper has confirmed that the Java process has been launched by locating its process. The state will always be changed to STARTING.

  • STARTING :

    The Java process has been launched. It will remain in this state until the WrapperManager class in the JVM has opened a back end socket with the Wrapper and then notified the Wrapper that the user Java application has been started, or the JVM starts to shut down. The amount of time that the Wrapper will be allowed to remain in this state is controlled by the wrapper.startup.timeout property. Normally the state will change to STARTED. In the event of a timeout, the state will change to KILLING.

  • STARTED :

    The WrapperManager class in the JVM has notified the Wrapper that the application is up and running. It will stay in this state until the JVM starts to shut down. Once in this state, the Wrapper will ping the WrapperManager class at an interval controlled by the wrapper.ping.interval property. The WrapperManager class must respond within a period controlled by the wrapper.ping.timeout property. Normally the Wrapper will stay in this state until asked to stop the JVM, in which case the state is changed to STOP. In the event of a ping timeout, the state will change to KILLING.

  • STOP :

    The Wrapper has received a request or decided that the JVM needs to be stopped. A request will be made asking the JVM to shutdown cleanly. The state will then be changed to STOPPING.

  • STOPPING :

    The JVM has begun to stop its internal application. It will remain in this state until the WrapperManager class in the JVM has notified the Wrapper that the application is stopped. The amount of time that the Wrapper will be allowed to remain in this state is controlled by the wrapper.shutdown.timeout property. Normally the state will change to STOPPED. In the event of a timeout, the state will change to KILLING.

  • STOPPED :

    The WrapperManager class in the JVM has notified the Wrapper that the application has stopped. It will remain in this state until the Java process actually terminates. The amount of time that the Wrapper will be allowed to remain in this state is controlled by the wrapper.jvm_exit.timeout property. Normally the state will change to DOWN_CHECK. In the event of a timeout, the state will change to KILLING.

  • KILLING :

    The Wrapper has decided that the Java process needs to be forcibly killed. If the wrapper.request_thread_dump_on_failed_jvm_exit property has been set, the Wrapper needs to wait long enough for Java to complete its dump before it is killed. This delay is configured with the wrapper.request_thread_dump_on_failed_jvm_exit.delay property. Once complete, the state will be change to KILL.

  • KILL :

    The Wrapper is ready to forcibly kill the Java process. Once the request has been made, the state will be changed to KILLED.

  • KILLED (Since ver. 3.5.18) :

    A request to forcibly kill the Java process has been sent, but the Wrapper is waiting for confirmation that the Java process is gone. The amount of time that the Wrapper will be allowed to remain in this state is controlled by the wrapper.jvm_terminate.timeout property. Once it has been confirmed that the Java process is gone, the state will change to DOWN_CHECK.

  • DOWN_CHECK :

    The Wrapper has verified that the JVM process no longer exists. This state is used to cleanup any stray child processes launched by the WrapperManager.exec method on the Professional edition. Once everything has been cleaned up, the state will change to DOWN_FLUSH.

  • DOWN_FLUSH :

    The Wrapper has verified that the JVM process no longer exists but there still may be some unlogged output in the stdout and stderr pipes from the java process. This state is used to make sure that all available log output is logged before continuing. Once done, the state will change to DOWN_CLEAN.

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.java.statusfile.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 "group" for this file. See the wrapper.*.group property.

Example: 
wrapper.java.statusfile.group=jenkins

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