This section covers the advanced properties which can be used to further configure the advanced features of Wrapper. These properties are not found in the default configuration file "wrapper.conf" shipped with the Wrapper. However they can be added as needed.

[Default Values]:

The default values of these properties have been designed to work with the majority of applications. In most cases, they should not be changed.

There are cases where they may need to be changed to suit the needs of a particular application. When doing so however, please take the time to read the documentation of the property carefully and make sure that changing it is really what you want to do.

[General/Common]

• wrapper.backend.type (3.5.8)

  Configures the communication between the Wrapper's process and the class running within the JVM.

• wrapper.child.status.loglevel (3.4.0) ( Pro )

  Controls the log level of messages related to the child process management.

• wrapper.console.quickedit (3.5.43)

  Enables or disables the QuickEdit Mode of the console attached to the Wrapper process.

• wrapper.console.quickedit.loglevel (3.5.37)

  Controls the log level of the warning printed when the console QuickEdit Mode is enabled.

• wrapper.disable_console_input (3.3.2)

  Disables the Wrapper's ability to process console input in the JVM.

• wrapper.disable_forced_shutdown (3.5.15)

  Disables forced shutdowns in a Windows console or UNIX shell.

• wrapper.forced_shutdown.delay (3.5.37)

  Controls the minimum amount of time required between two CTRL-C or TERM signals to initiate a forced shutdown.

• wrapper.disable_restarts (3.2.0)

  Disables all JVM restarts by the Wrapper, including restarts caused by errors and requested restarts from within the JVM.

• wrapper.disable_restarts.automatic (3.3.4)

  Disables automatic JVM restarts by the Wrapper, including restarts when the JVM crashes or exits unexpectedly.

• wrapper.disable_shutdown_hook (1.0.0)

  Disables detection of calls to System.exit().

• wrapper.disable_tests (3.5.16)

  Disables several methods used for testing the Wrapper's failure modes.

• wrapper.environment.dump.loglevel (3.5.36)

  Controls at which log level the environment variables visible to the Wrapper will be logged.

• wrapper.exit_code.error (3.5.31)

  Specifies the exit code to use when the Wrapper stops with an error.

• wrapper.ignore_sequence_gaps (3.3.6)

  Controls whether or not gaps are allowed in the numbered components of sequential properties.

• wrapper.ignore_signals (3.0.5)

  Controls whether or not the Wrapper should ignore system signals.

• wrapper.java.detect_debug_jvm (3.3.6)

  Enables the detection of a debugger in the command line.

• wrapper.java.monitor_exit (3.5.42) ( Std/Pro )

  Enables monitoring of the Java process exit by the Event Log.

• wrapper.java.version.fallback (3.5.38)

  Specifies a fallback value to be used when the Java version failed to be parsed.

• wrapper.java.version.max (3.5.35)

  Specifies the maximum version of Java for which the Wrapper is allowed to launch the Java Application.

• wrapper.java.version.min (3.5.35)

  Specifies the minimum version of Java for which the Wrapper is allowed to launch the Java Application.

• wrapper.java.version.output (3.5.17)

  Displays the version of the JVM used by the Wrapper.

• wrapper.java.version.timeout (3.5.27)

  Configures the number of seconds allowed for the child process to print the JVM version before it is terminated.

• wrapper.jvm_detach_started (3.5.8)

  Allows the JVM to be left running as a standalone process after the Wrapper exits.

• wrapper.java.errfile (3.5.8)

  Sets the path to a file where the stderr messages of a detached JVM are redirected to.

• wrapper.java.outfile (3.5.8)

  Sets the path to a file where the stdout messages of a detached JVM are redirected to.

• wrapper.listener.force_stop (3.3.2)

  Controls whether or not the WrapperListener.stop method is called on shutdown.

• wrapper.monitor_exit (3.5.42) ( Std/Pro )

  Enables monitoring of the Wrapper process exit by the Event Log.

• wrapper.native_library (3.1.0)

  Sets the base name of the Wrapper native library.

• wrapper.on_exit.<n> (3.1.0)

  Configure the actions to take place when the Java application exits with the specified exit codes.

• wrapper.pausable (3.5.0)

  Enables the PAUSE and RESUME actions.

• wrapper.pausable.stop_jvm (3.5.0)

  Specifies if the JVM should be stopped when the Wrapper is paused, or if the Java application should handle a control event to pause itself.

• wrapper.pause_on_startup (3.5.5)

  Causes the Wrapper to go immediately into a paused state, without launching a JVM.

• wrapper.request_thread_dump_on_failed_jvm_exit (2.2.7)

  Attempts to perform a thread dump whenever the JVM did not exit on request.

• wrapper.request_thread_dump_on_failed_jvm_exit.delay (3.5.6)

  Configures the number of seconds allowed for the thread dump to complete before killing the JVM process.

• wrapper.restart.reload_configuration (3.2.0)

  Controls whether or not the Wrapper configuration file will be reloaded in the event of a JVM restart.

• wrapper.test.no_jvm (3.5.35)

  Runs the Wrapper without launching a JVM.

• wrapper.use_javaio_thread (3.5.8)

  Controls if the Wrapper should use a dedicated thread to process console output from the JVM.

• wrapper.user_logoffs.message (3.5.38)

  Sets the description displayed by Windows when the Wrapper is stopping and blocking a user log off.

• wrapper.working.dir (3.1.0)

  Sets the path to the working directory.

[Start Delay]

• wrapper.restart.delay (2.2.9)

  Controls the number of seconds to wait between a JVM exiting and a new JVM being launched.

• wrapper.startup.delay (3.1.0)

  Controls the number of seconds to wait between the Wrapper being launched and the first JVM being launched.

• wrapper.startup.delay.console (3.1.0)

  Overrides wrapper.startup.delay when running as a console application.

• wrapper.startup.delay.service (3.1.0) ( Pro )

  Overrides wrapper.startup.delay when running as a service.

[Start/Stop TimeOut]

• wrapper.startup_thread.timeout (3.5.11)

  Configures the number of seconds to allow asynchronous startup operations to be completed.

• wrapper.startup.timeout (1.1.0)

  Configures the number of seconds to allow between the time the Wrapper launches the JVM and the time the JVM responds that the application has started.

• wrapper.cpu.timeout (2.2.8)

  Configures the number of seconds without CPU before the JVM sends a warning and extend timeouts.

• wrapper.shutdown.timeout (2.2.7)

  Configures the number of seconds to allow between the time the Wrapper asks the JVM to shutdown and the time the JVM responds that it is stopping.

• wrapper.jvm_cleanup.timeout (3.4.0)

  Configures the number of seconds allowed for the Wrapper to clean up child processes after the JVM has been shutdown.

• wrapper.jvm_exit.timeout (2.2.8)

  Configures the number of seconds to allow between the time the JVM reports it is stopped and the time the JVM process actually terminates.

• wrapper.jvm_kill.delay (3.5.6) ( Pro )

  Configures the number of seconds to pause between firing a JVM kill event and actually killing it.

[Processor Affinity]

• wrapper.cpu_affinity.set (3.5.27) ( Pro )

  Enables or disables processor affinity for the Wrapper.

• wrapper.cpu_affinity.default (3.5.27) ( Pro )

  Enables or prevents the Wrapper from running on all CPUs.

• wrapper.java.cpu_affinity.<n> (3.5.27) ( Pro )

  Enable or prevent the JVM process from running on a specific CPU.

• wrapper.cpu_affinity.strict (3.5.27) ( Pro )

  Specifies if the Wrapper should stop when its CPU affinity configuration causes an exception.

• wrapper.java.cpu_affinity.set (3.5.27) ( Pro )

  Enables or disables processor affinity for the JVM process.

• wrapper.java.cpu_affinity.default (3.5.27) ( Pro )

  Enables or prevents the JVM process from running on all CPUs.

• wrapper.java.cpu_affinity.<n> (3.5.27) ( Pro )

  Enable or prevent the JVM process from running on a specific CPU.

• wrapper.java.cpu_affinity.strict (3.5.27) ( Pro )

  Specifies if the Wrapper should stop when the CPU affinity configuration of the JVM process causes an exception.

[Ping]

• wrapper.ping.alert.loglevel (3.5.16)

  Controls at which log level the ping alert messages will be logged.

• wrapper.ping.alert.threshold (3.5.16)

  Prints a warning whenever a ping response takes longer than the specified number of seconds.

• wrapper.ping.interval (3.0.5)

  Configures the number of seconds between two ping requests to the JVM.

• wrapper.ping.interval.logged (3.2.4)

  Configures the number of seconds between two ping requests that should be logged.

• wrapper.ping.timeout (1.0.0)

  Configures the number of seconds to allow between two ping responses coming from the JVM.

• wrapper.ping.timeout.action (3.5.16)

  Configures the actions to take place whenever the ping timeout has expired.

[Invocations]

• wrapper.max_failed_invocations (2.2.8)

  Configures the number of times the Wrapper will attempt to restart the JVM.

• wrapper.successful_invocation_time (2.2.8)

  Configures the minimum amount of time that the Java application must remain running to be considered as successfully started.

[Time/Clock]

• wrapper.timer.<n>.action (3.3.0) ( Pro )

  Configure the actions to take place whenever timers are fired.

• wrapper.timer.<n>.interval (3.3.0) ( Pro )

  Configure the intervals at which to execute timers.

• wrapper.timer.max_catchup (3.3.0) ( Pro )

  Configures the maximum number of seconds that skipped timer events will be allowed to be fired catching up with sudden time change.

• wrapper.use_system_time (3.1.0)

  Uses the system time (instead of a background timer thread) for all internal timekeeping functions of the Wrapper.

• wrapper.timer_fast_threshold (3.1.0)

  Prints a warning whenever the system time springs forward by more than the specified number of seconds.

• wrapper.timer_slow_threshold (3.1.0)

  Prints a warning whenever the system time falls back by more than the specified number of seconds.

• wrapper.timezone (3.3.6) ( Std/Pro )

  Sets the timezone used by internal timekeeping functions of the Wrapper.

• wrapper.timezone.debug_timestamps (3.5.30) ( Std/Pro )

  Displays debugging information in the timestamps of the log outputs.

• wrapper.timezone.folder (3.5.29) ( Std/Pro )

  Sets the path to a directory containing the IANA Time Zone Database source files.

• wrapper.timezone.use_summer_time (3.3.7) ( Std/Pro )

  Enables daylight saving time.

• wrapper.java.timezone (3.5.46) ( Std/Pro )

  Sets the timezone used by the Java process.

[Port]

• wrapper.port (1.0.0)

  Configures the port that the Wrapper will use to connect to the JVM.

• wrapper.port.address (3.5.18)

  Sets the IP address used for the communication between the Wrapper and the JVM.

• wrapper.port.max (3.2.0)

  Specifies the upper limit of the port range that the Wrapper will use to connect to the JVM.

• wrapper.port.min (3.2.0)

  Specifies the lower limit of the port range that the Wrapper will use to connect to the JVM.

• wrapper.jvm.port (3.2.0)

  Configures the port that the JVM will use to connect back to the Wrapper.

• wrapper.jvm.port.max (3.2.0)

  Specifies the upper limit of the port range that the JVM will use to connect back to the Wrapper.

• wrapper.jvm.port.min (3.2.0)

  Specifies the lower limit of the port range that the JVM will use to connect back to the Wrapper.

[x-file]

• wrapper.anchorfile (3.1.1)

  Sets the path to an anchor file created on startup.

• wrapper.anchorfile.poll_interval (3.5.31)

  Specifies time intervals to use when testing the existence of the anchor file.

• wrapper.anchor.poll_interval (3.1.1, deprecated as of 3.5.31)

  Specifies time intervals to use when testing the existence of the anchor file.

• wrapper.commandfile (3.2.0)

  Sets the path to a file containing commands to be executed.

• wrapper.commandfile.enable_tests (3.5.0)

  Enables test commands.

• wrapper.commandfile.poll_interval (3.5.31)

  Specifies time intervals to use when testing the existence of command file.

• wrapper.command.poll_interval (3.2.0, deprecated as of 3.5.31)

  Specifies time intervals to use when testing the existence of command file.

• wrapper.lockfile (3.2.0)

  Configures a lock file containing the Wrapper's process ID.

• 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.pidfile.strict (3.5.14)

  Stops the Wrapper if a pid file already exists on startup.

• wrapper.statusfile (3.2.0)

  Sets the path to a file where the current Wrapper status 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.pidfile (3.0.5)

  Sets the path to a file where the PID of the Java process 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.

[Group]

• wrapper.group (3.5.38)

  Specifies the default value for the wrapper.*.group properties.

• wrapper.group.strict (3.5.38)

  Causes the Wrapper to stop with a FATAL error whenever an invalid value is detected while loading the wrapper.*.group properties.

• wrapper.anchorfile.group (3.5.38)
• wrapper.lockfile.group (3.5.38)
• wrapper.pidfile.group (3.5.38)
• wrapper.statusfile.group (3.5.38)
• wrapper.java.idfile.group (3.5.38)
• wrapper.java.pidfile.group (3.5.38)
• wrapper.java.statusfile.group (3.5.38)

[umask]

• wrapper.umask (3.2.0)

  Specifies the permissions for the files created by the Wrapper.

• wrapper.anchorfile.umask (3.2.0)
• wrapper.lockfile.umask (3.2.0)
• wrapper.pidfile.umask (3.2.0)
• wrapper.statusfile.umask (3.2.0)
• wrapper.java.umask (3.2.0)
• wrapper.java.idfile.umask (3.2.0)
• wrapper.java.pidfile.umask (3.2.0)
• wrapper.java.statusfile.umask (3.2.0)

[View/Display]

• wrapper.console.title (3.1.0)

  Sets the title of the console in which the Wrapper is running.

• wrapper.console.title.<platform> (3.1.0)

  Set the console title per platform.

• wrapper.name (3.3.0)

  Configures the service name used in error messages, events, etc.

• wrapper.displayname (3.3.0)

  Sets the display name of the service used in system error messages, events, etc.

• wrapper.description (3.3.0)

  Sets the service description to use in system error messages, events, etc.

[DeadLock]

• wrapper.check.deadlock (3.5.0) ( Std/Pro )

  Enables the detection of deadlocks.

• wrapper.check.deadlock.action (3.5.0) ( Std/Pro )

  Configures the actions to take place whenever deadlocks are detected.

• wrapper.check.deadlock.interval (3.5.0) ( Std/Pro )

  Configures time intervals to check for deadlocks.

• wrapper.check.deadlock.output (3.5.0) ( Std/Pro )

  Specifies the amount of information contained in the deadlock report.

[Privileges]

• wrapper.ntservice.required_privileges (3.5.57) ( Pro )

  Configures the list of required privileges for the service.

• wrapper.privileges.disable (3.5.57) ( Pro )

  Disables privileges for the Wrapper process.

• wrapper.privileges.enable (3.5.57) ( Pro )

  Enables privileges for the Wrapper process.

• wrapper.privileges.remove (3.5.57) ( Pro )

  Removes privileges from the access token of the Wrapper process.

• wrapper.java.privileges.disable (3.5.57) ( Pro )

  Disables privileges for the Java process.

• wrapper.java.privileges.enable (3.5.57) ( Pro )

  Enables privileges for the Java process.

• wrapper.java.privileges.remove (3.5.57) ( Pro )

  Removes privileges from the access token of the Java process.

• wrapper.event.<event_name>.command.privileges.disable (3.5.57) ( Pro )

  Disables privileges for event commands.

• wrapper.event.<event_name>.command.privileges.enable (3.5.57) ( Pro )

  Enables privileges for event commands.

• wrapper.event.<event_name>.command.privileges.remove (3.5.57) ( Pro )

  Removes privileges from the access tokens of event commands.

[Deprecated]

• wrapper.monitor_thread_count (3.2.0 (Deprecated as of 3.2.1))
• wrapper.thread_count_delay (3.2.0 (Deprecated as of 3.2.1))