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

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 when the first Java process is launched and then whenever the internal status changes. The file will be deleted when the Wrapper process has terminated, and will be created again with reflecting the DOWN status when the Java process is being restarted.

Example:
wrapper.java.statusfile=./myapp.java.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 Java process status.

Possible values include:

  • DOWN - 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.

  • 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).

  • 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.

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

  • 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.

  • 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.

  • 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 that 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.

  • 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.

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