Java Service Wrapper - Configuration Property Overview

Configuration Property Overview

The Java Service Wrapper uses a configuration file wrapper.conf to control the various Wrapper settings. The file also contains all of the information necessary to launch a JVM instance with the correct command line required by a given application.

This section includes an example configuration file and covers some general features which apply to all properties. Each property is individually explained below. They can be accessed by category or name. Many of the properties which will most likely be required are also explained elsewhere in this document.

Property List by Category
Property List by Name

Note

The Wrapper configuration file is very similar, but not exactly the same as a Java Properties file. For example the '\' character is not interpreted as an escape character (escape sequence). The '#' character is interpreted as a comment character. To include a '#' character in a property value, the value must either be quoted (" ") or escaped by a second '#' character.

Cascading Configuration Files ("include file")

Property List by Category

Property List by Name

Properties added after the initial release are followed by the Wrapper version in which they were implemented.

[A]

wrapper.adviser (3.1.0)
Displays advice whenever certain common problems are detected.
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.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.anchorfile.umask (3.2.0)
Specifies the umask to use when creating the anchor file.
wrapper.app.parameter.<n> (1.0.0)
Set the parameters of your Java application.
wrapper.app.parameter_file (3.5.17)
Specifies the path of the file containing the application parameters.
wrapper.app.parameter_file.required (3.5.36)
Specifies if the parameter file is required or not.
wrapper.app.parameter_file.stripquotes (3.5.17)
Strips the quotes in the application parameters listed in the parameter file.

[B]

wrapper.backend.type (3.5.8)
Configures the communication between the Wrapper's process and the class running within the JVM.

[C]

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.
wrapper.child.status.loglevel (3.4.0) ( Pro )
Controls the log level of messages related to the child process management.
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.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.console.direct (3.5.21)
Specifies whether the Wrapper will use Windows APIs or pipes to write console log outputs.
wrapper.console.error_to_stderr (3.5.3)
Controls whether error messages sent to the console are logged through stdout or stderr.
wrapper.console.fatal_to_stderr (3.5.3)
Controls whether fatal messages sent to the console are logged through stdout or stderr.
wrapper.console.flush (3.2.0)
Configures the Wrapper to flush stdout after each line of output is sent to the console.
wrapper.console.format (1.0.0)
Configures the format of outputs sent to the console.
wrapper.console.loglevel (1.0.0)
Filters messages sent to the console according to their log levels.
wrapper.console.title (3.1.0)
Sets the title of the console in which the Wrapper is running.
wrapper.console.title.<platform> (3.3.0)
Set the console title per platform.
wrapper.console.warn_to_stderr (3.5.3)
Controls whether warning messages sent to the console are logged through stdout or stderr.
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.cpu_affinity.<n> (3.5.27) ( Pro )
Enables or prevents the Wrapper 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.cpu.timeout (2.2.8)
Configures the number of seconds without CPU before the JVM sends a warning and extend timeouts.

[D]

wrapper.daemonize (3.0.0)
Spawns a fork of the Wrapper process as a detached non-session group leader.
wrapper.debug (1.0.0)
Enables debug logging both to the console and log file.
wrapper.description (3.3.0)
Sets the service description to use in system error messages, events, etc.
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.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.displayname (3.3.0)
Sets the display name of the service used in system error messages, events, etc.

[E]

wrapper.environment.dump (3.5.0, deprecated as of 3.5.36)
Lists all the environment variables visible to the Wrapper.
wrapper.environment.dump.loglevel (3.5.36)
Controls at which log level the environment variables visible to the Wrapper will be logged.
wrapper.event.<event_name>.command.argv.<n> (3.3.0) ( Pro )
Specify a command (and its arguments) to be executed in response to a specific event.
wrapper.event.<event_name>.command.block (3.4.1) ( Pro )
Tells the Wrapper whether or not to wait for the command to complete before allowing the Wrapper to continue.
wrapper.event.<event_name>.command.block.action (3.4.1) ( Pro )
Configures the action to take place whenever a configured event command fails to complete within the specified timeout.
wrapper.event.<event_name>.command.block.timeout (3.3.0) ( Pro )
Configures how long the Wrapper will wait for a configured event to complete.
wrapper.event.<event_name>.command.loglevel (3.3.0) ( Pro )
Controls the log level of messages related to the event commands being executed.
wrapper.event.<event_name>.command.on_exit.<n> (3.3.0) ( Pro )
Control what the Wrapper will do in response to specific exit codes of event commands.
wrapper.event.<event_name>.email (3.3.0) ( Pro )
Configures whether or not emails should be sent for a particular event.
wrapper.event.<event_name>.email.attach_log (3.4.0, deprecated as of 3.5.31) ( Pro )
Enables sending a log file in the attachments of the emails.
wrapper.event.<event_name>.email.maillog (3.5.31) ( Pro )
Enables sending logs as an attachment or directly in the body of the emails.

wrapper.event.default.email.maillog.lines (3.4.0) ( Pro )
Specifies the number of lines of the logs included in the emails.
wrapper.event.default.email.maillog.format (3.4.0) ( Pro )
Configures the format of the logs included in the emails.
wrapper.event.default.email.maillog.loglevel (3.4.0) ( Pro )
Filters messages included in the emails according to their log levels.

wrapper.event.<event_name>.email.body (3.3.0) ( Pro )
Configures the body of the emails.
wrapper.event.<event_name>.email.client.host (3.3.2) ( Pro )
Sets the name of the machine running the Wrapper and sent to the SMTP server.
wrapper.event.<event_name>.email.debug (3.3.0) ( Pro )
Prints detailed information when emails are sent.
wrapper.event.<event_name>.email.receive.timeout (3.3.2) ( Pro )
Configures the maximum number of seconds to wait for a reply from the SMTP server after a command is sent by the Wrapper.
wrapper.event.<event_name>.email.send.timeout (3.3.2) ( Pro )
Configures the maximum number of seconds to wait when the Wrapper attempts to send a command to the SMTP server.
wrapper.event.<event_name>.email.sender (3.3.0) ( Pro )
Specifies the from address of the emails.
wrapper.event.<event_name>.email.smtp.auth.userid (3.5.3) ( Pro )
Specifies the user Id to use for authentication when connecting to an SMTP server.
wrapper.event.<event_name>.email.smtp.auth.type (3.5.3) ( Pro )
Specifies an authentication method to use when connecting to an SMTP server.
wrapper.event.<event_name>.email.smtp.auth.password (3.5.3) ( Pro )
Specifies the password to use for authentication when connecting to an SMTP server.
wrapper.event.<event_name>.email.smtp.host (3.3.0) ( Pro )
Configures the SMTP host which the Wrapper will attempt to connect to when sending emails.
wrapper.event.<event_name>.email.smtp.port (3.3.0) ( Pro )
Configures the SMTP port which the Wrapper will attempt to connect to when sending emails.
wrapper.event.<event_name>.email.subject (3.3.0) ( Pro )
Configures the subject of the emails.
wrapper.event.<event_name>.email.recipient (3.3.0) ( Pro )
Specifies the recipient(s) of the emails.
wrapper.event.<event_name>.loglevel (3.3.6) ( Pro )
Controls the log level of messages being logged each time a specific event takes place.
wrapper.event.<event_name>.message (3.3.6) ( Pro )
Controls the message which will be logged each time a specific event takes place.
wrapper.event.<event_name>.set_environment (3.3.0, deprecated as of 3.3.6) ( Pro )
wrapper.exit_code.error (3.5.31)
Specifies the exit code to use when the Wrapper stops with an error.

[F]

wrapper.filter.action.<n> (3.0.0)
Configure the actions to take place whenever filters are triggered.
wrapper.filter.allow_wildcards.<n> (3.5.5)
Allow usage of wildcards in the trigger texts.
wrapper.filter.message.<n> (3.5.0)
Specify messages to be displayed whenever a trigger is fired.
wrapper.filter.trigger.<n> (3.0.0)
Specify the texts to trigger actions when matching a log message.

[I]

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.ignore_user_logoffs (3.3.1)
Controls whether or not the Wrapper will respond to Windows LogOff events when running in console mode.

[J]

wrapper.java.additional.<n> (1.0.0)
Configure additional parameters to pass to the JVM.
wrapper.java.additional.<n>.java_version.max (3.5.36) ( Std/Pro )
Append option with index 'n' only if the Java version is lower than or equal to the specified value.
wrapper.java.additional.<n>.java_version.min (3.5.36) ( Std/Pro )
Append option with index 'n' only if the Java version is greater than or equal to the specified value.
wrapper.java.additional.<n>.stripquotes (1.0.0)
Strip the quotes in the JVM parameters (Unix only).
wrapper.java.additional.auto_bits (3.3.5)
Adds the bit mode (32 or 64 bit) corresponding to the bit of the Wrapper binary to the JVM parameters.
wrapper.java.additional.auto_bits.<platform> (3.5.15)
Activate or deactivate the auto_bits functionality individually on certain supported platforms.
wrapper.java.additional.default.stripquotes (3.5.17)
Strips the quotes for all "java.additional" properties (Unix only).
wrapper.java.additional_file (3.5.16)
Sets the path to a file containing JVM parameters.
wrapper.java.additional_file.required (3.5.36)
Specifies if the Java additional file is required or not.
wrapper.java.additional_file.stripquotes (3.5.16)
Strips the quotes in the JVM parameters listed in the "additional file" (Unix only).
wrapper.java.classpath.<n> (1.0.0)
Set the elements of the classpath passed to the JVM.
wrapper.java.classpath.missing.loglevel (3.5.26)
Controls the log level of the messages reporting any missing classpath elements.
wrapper.java.classpath.use_environment (3.4.1)
Configures whether the Wrapper passes the generated classpath to the JVM on the Java command line or by setting the CLASSPATH environment variable.
wrapper.java.command (1.0.0)
Sets the path to the Java executable.
wrapper.java.command.resolve (1.0.0)
Specifies whether the Wrapper should try to resolve the specified Java command or continue using the unresolved path as possibly defined.
wrapper.java.command.loglevel (3.1.2)
Controls at which log level the generated command line will be logged.
wrapper.java.detect_debug_jvm (3.3.6)
Enables the detection of a debugger in the command line.
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.idfile (3.2.0)
Sets the path to a file where the current Java ID generated by the Wrapper will be written.
wrapper.java.idfile.umask (3.2.0)
Specifies the umask to use when creating the Java ID file.
wrapper.java.initmemory (1.0.0)
Sets the initial amount of memory in megabytes that the JVM should allocate at startup.
wrapper.java.initmemory.percent (3.3.0) ( Std/Pro )
Sets the percentage of the physical memory that the JVM should allocate at startup.
wrapper.java.library.path.<n> (2.2.9)
Specify a list of directories containing any native libraries used by the Wrapper or the Java application.
wrapper.java.library.path.append_system_path (3.1.0)
Appends the content of the system PATH to the Java library path.
wrapper.java.mainclass (1.0.0)
Sets the class holding the main method called when the Wrapper starts the JVM.
wrapper.java.maxmemory (1.0.0)
Sets the maximum amount of memory in megabytes that the JVM is allowed to use.
wrapper.java.maxmemory.percent (3.3.0) ( Std/Pro )
Sets the percentage of the physical memory that the JVM is allowed to use.
wrapper.java.outfile (3.5.8)
Sets the path to a file where the stdout messages of a detached JVM are redirected to.
wrapper.java.pidfile (3.0.5)
Sets the path to a file where the PID of the Java process will be written.
wrapper.java.pidfile.umask (3.2.0)
Specifies the umask to use when creating the Java pid file.
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 )
Enables or prevents 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.
wrapper.java.statusfile (3.2.0)
Sets the path to a file where the current status of the JVM will be written.
wrapper.java.statusfile.umask (3.2.0)
Specifies the umask to use when creating the Java status file.
wrapper.java.tmpdir.required (3.5.0)
Specifies if the Wrapper should exit when the Java temporary directory cannot be written to.
wrapper.java.tmpdir.warn_silently (3.5.0)
Specifies whether a message should be logged at the DEBUG or WARN log level when the Java temporary directory could not be written to.
wrapper.java.umask (3.2.0)
Specifies the default umask of the Java process, and thus of any files created by the Java application.
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.javaio.buffer_size (3.5.21)
Controls the size of the buffer used by the pipe between the JVM and Wrapper processes.
wrapper.javaio.use_thread (3.5.21)
Controls whether the Wrapper uses a dedicated thread to process console output from the JVM.
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_detach_started (3.5.8)
Allows the JVM to be left running as a standalone process after the Wrapper exits.
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.
wrapper.jvm.encoding (3.5.35)
Specifies the default encoding of the JVM when it should be different than the encoding used by the Wrapper.
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.

[L]

wrapper.lang (3.5.0) ( Std/Pro )
Specifies the output language of the Wrapper.
wrapper.lang.domain (3.5.0) ( Std/Pro )
Sets the base name of the language files.
wrapper.lang.encoding (3.5.0, deprecated as of 3.5.35) ( Std/Pro )
Specifies the encoding part of the locale used by the Wrapper process.
wrapper.lang.folder (3.5.0) ( Std/Pro )
Sets the location of the language files.
wrapper.lang.<platform>.encoding (3.5.35) ( Std/Pro )
Specifies the encoding part of the locale used by the Wrapper process on a certain platform.
wrapper.lang.unix.encoding (3.5.35) ( Std/Pro )
Specifies the encoding part of the locale used by the Wrapper process on Unix.
wrapper.lang.windows.encoding (3.5.35) ( Std/Pro )
Specifies the encoding part of the locale used by the Wrapper process on Windows.
wrapper.license.debug (3.4.0) ( Std/Pro )
Prints information about the license keys found.
wrapper.license.dev_application (3.3.0) ( Std/Pro )
wrapper.license.features (3.3.0) ( Std/Pro )
wrapper.license.host_id (3.3.0) ( Std/Pro )
wrapper.license.id (3.3.0) ( Std/Pro )
wrapper.license.key.<n> (3.3.0) ( Std/Pro )
wrapper.license.lease_term.begin_date (3.3.0) ( Std/Pro )
wrapper.license.lease_term.end_date (3.3.0) ( Std/Pro )
wrapper.license.licensee (3.3.0) ( Std/Pro )
wrapper.license.type (3.3.0) ( Std/Pro )
wrapper.license.upgrade_term.begin_date (3.3.0) ( Std/Pro )
wrapper.listener.force_stop (3.3.2)
Controls whether or not the WrapperListener.stop method is called on shutdown.
wrapper.lockfile (3.2.0)
Configures a lock file containing the Wrapper's process ID.
wrapper.lockfile.umask (3.2.0)
Specifies the umask to use when creating the lock file.
wrapper.log.lf_delay.threshold (3.5.10)
Sets a threshold to split JVM messages that would be too long to be printed at once.
wrapper.log.warning.threshold (3.5.8)
Prints a warning when a log entry takes longer to be printed than the specified number of seconds.
wrapper.logdialog.enable (3.3.1) ( Std/Pro )
Controls whether or not the log dialog should be displayed on shutdown when the "wrapperW.exe" exits in an error state.
wrapper.logdialog.format (3.3.1) ( Std/Pro )
Configures the format of the outputs displayed in the log dialog.
wrapper.logdialog.lines (3.3.1) ( Std/Pro )
Controls the maximum number of output lines displayed in the log dialog.
wrapper.logdialog.loglevel (3.3.1) ( Std/Pro )
Filters messages of the log dialog according to their log levels.
wrapper.logfile (1.0.0)
Sets the path to the Wrapper log file.
wrapper.logfile.close.timeout (3.5.21)
Controls the number of seconds at which the log file should close after the last log entry.
wrapper.logfile.flush.timeout (3.5.21)
Configures the interval in seconds at which the Wrapper flushes all outputs to the log file.
wrapper.logfile.format (2.2.5)
Configures the format of the outputs sent to the log file.
wrapper.logfile.inactivity.timeout (3.2.0, deprecated as of 3.5.21)
wrapper.logfile.loglevel (2.2.5)
Filters messages sent to the log file according to their log levels.
wrapper.logfile.maxfiles (2.2.5)
Controls the maximum number of rolled files.
wrapper.logfile.maxsize (2.2.5)
Controls the maximum size of rolled files.
wrapper.logfile.purge.pattern (3.3.8)
Controls the file pattern to purge old log files.
wrapper.logfile.purge.sort (3.3.8)
Configures the sorting mode of the rolled files to purge the last ones.
wrapper.logfile.rollmode (3.2.0)
Sets the roll mode of the log file.
wrapper.logfile.umask (3.2.0)
Specifies the umask to use when creating the log file.

[M]

wrapper.max_failed_invocations (2.2.8)
Configures the number of times the Wrapper will attempt to restart the JVM.
wrapper.monitor_thread_count (3.2.0, deprecated as of 3.2.1)
wrapper.max_hostid_timeout (3.4.0) ( Std/Pro )
Configures the maximum number of seconds the Wrapper should wait for network interfaces to come up.

[N]

wrapper.name (3.3.0)
Configures the service name used in error messages, events, etc.
wrapper.native_library (3.1.0)
Sets the base name of the Wrapper native library.
wrapper.ntservice.account (3.0.0)
Specifies the account to use when running as a Windows service.
wrapper.ntservice.account.prompt (3.5.5)
Asks the user to input the domain, account name and password in order to install the Wrapper as a Windows service.
wrapper.ntservice.console (3.1.0)
Causes the Wrapper to allocate and display a console window when running as a Windows service.
wrapper.ntservice.dependency.<n> (1.0.0)
List the names of other services or groups which must be running before this service can be started.
wrapper.ntservice.description (2.2.5)
Sets the description used in the Services panel.
wrapper.ntservice.displayname (1.0.0)
Sets the display name used in the Services panel.
wrapper.ntservice.generate_console (3.3.2)
Added to force the Wrapper to always create an internal console when running as a Windows service.
wrapper.ntservice.hide_console (3.0.4)
Specifies to hide the console when running as a Windows service.
wrapper.ntservice.interactive (3.0.0)
Makes it possible for the service to display a GUI and interact with the desktop.
wrapper.ntservice.load_order_group (3.0.4)
Specifies the name of the load ordering group of which the service will be a member.
wrapper.ntservice.name (1.0.0)
Configures the service name used in error messages, events, etc.
wrapper.ntservice.password (3.0.0)
Sets the password for a specific user account.
wrapper.ntservice.password.prompt (3.2.0)
Asks the user to input a password when installing the Wrapper as a service.
wrapper.ntservice.password.prompt.mask (3.2.0)
Prevents your password to be displayed in the console.
wrapper.ntservice.pausable (3.2.1, deprecated as of 3.5.0)
wrapper.ntservice.pausable.stop_jvm (3.2.1, deprecated as of 3.5.0)
wrapper.ntservice.preshutdown (3.5.30)
Enables the service to listen to preshutdown notifications.
wrapper.ntservice.preshutdown.timeout (3.5.30)
Configures the maximum number of seconds the service control manager should wait until a service listening to preshutdown notifications will stop.
wrapper.ntservice.process_priority (2.2.7)
Specifies the priority at which the Wrapper and its JVM will be run.
wrapper.ntservice.recovery.reset (3.5.5) ( Std/Pro )
Configures the time in seconds, without any errors, after which the service control manager will reset the failure count to 0.
wrapper.ntservice.recovery.command (3.5.5) ( Std/Pro )
Configures a command to be executed in a response to a failure.
wrapper.ntservice.recovery.reboot_msg (3.5.5) ( Std/Pro )
Specifies a message to be logged in the Event Viewer when the system reboots due to a service failure.
wrapper.ntservice.recovery.<n>.failure (3.5.5) ( Std/Pro )
Configure the actions to take place when the Wrapper service crashes or exits <n> times.
wrapper.ntservice.recovery.<n>.delay (3.5.5) ( Std/Pro )
Configure the maximum number of seconds that the service control manager should wait until it actually performs the specified actions.
wrapper.ntservice.starttype (1.0.0)
Configures the start mode of the service.

[O]

wrapper.on_exit.<n> (3.1.0)
Configure the actions to take place when the Java application exits with the specified exit codes.

[P]

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.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.pidfile.umask (3.2.0)
Specifies the umask to use when creating the pid file.
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.
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.properties.dump.format (3.5.35)
Configures the format to use when dumping the configuration properties.
wrapper.properties.dump.loglevel (3.5.30)
Controls at which log level the configuration properties will be logged.
wrapper.property_warning.loglevel (3.5.21)
Controls at which log level warnings about invalid property values will be logged.

[R]

wrapper.registry.java_home (3.2.4)
Specifies a registry key containing the path to the Java home folder.
wrapper.registry.java_version (3.5.36) ( Std/Pro )
Specifies a version of the JRE to use when locating the Java command from the Windows registry.
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.delay (2.2.9)
Controls the number of seconds to wait between a JVM exiting and a new JVM being launched.
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.

[S]

wrapper.share.<n>.target (3.5.0) ( Std/Pro )
Set the targets on the local machine to which the network resources should get mapped to.
wrapper.share.<n>.location (3.5.0) ( Std/Pro )
Set the locations of network resources such as a shared file, directory, or printer.
wrapper.share.<n>.type (3.5.0) ( Std/Pro )
Specify the type of network resources to connect to.
wrapper.share.<n>.account (3.5.0) ( Std/Pro )
Specify accounts to connect to network resources.
wrapper.share.<n>.password (3.5.0) ( Std/Pro )
Specify passwords to connect to network resources.
wrapper.share.<n>.startup.failure (3.5.0) ( Std/Pro )
Specify whether to shutdown or continue when failing to mount network resources.
wrapper.share.<n>.startup.premapped (3.5.0) ( Std/Pro )
Specify whether to shutdown or continue when network resources could not be mounted because they already exist.
wrapper.share.<n>.startup.max_retries (3.5.0) ( Std/Pro )
Define how many times the Wrapper should try to mount network resources.
wrapper.share.<n>.startup.retry_interval (3.5.0) ( Std/Pro )
Specify intervals in seconds that the Wrapper will wait until it retries to mount network resources.
wrapper.share.<n>.shutdown.unmap (3.5.0) ( Std/Pro )
Specify if the Wrapper should disconnect network resources when shutting down.
wrapper.share.<n>.shutdown.unmap.force (3.5.0) ( Std/Pro )
Specify whether disconnections should occur even if there are open files or running jobs.
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.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.
wrapper.single_invocation (3.1.2)
Ensures that only one instance of the Wrapper is running at a given time.
wrapper.single_invocation.notify (3.5.28) ( Std/Pro )
Triggers an event and attempts to set focus to the running Java application when a second instance is launched.
wrapper.single_invocation.notify.focus_window (3.5.28) ( Std/Pro )
Sets the focus to the top window of the Java application whenever a second instance is launched.
wrapper.single_invocation.notify.timeout (3.5.28) ( Std/Pro )
Configures the maximum number of seconds that the Wrapper will wait for a reply from the running instance.
wrapper.single_invocation.notify.show_splashscreen (3.5.28) ( Std/Pro )
Shows the splash screen whenever a second instance is launched.
wrapper.splashscreen.mode (3.3.7) ( Std/Pro )
Configures the moment to display the splash screen when running "wrapperW.exe".
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.service (3.1.0)
Overrides wrapper.startup.delay when running as a service.
wrapper.startup.delay.console (3.1.0)
Overrides wrapper.startup.delay when running as a console application.
wrapper.startup_thread.timeout (3.5.11)
Configures the number of seconds to allow asynchronous startup operations to be completed.
wrapper.startup.timeout (1.0.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.statusfile (3.2.0)
Sets the path to a file where the current Wrapper status will be written.
wrapper.statusfile.umask (3.2.0)
Specifies the umask to use when creating the status file.
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.
wrapper.syslog.facility (3.2.1)
Sets the facility code to use when logging to the syslog on UNIX systems.
wrapper.syslog.ident (3.2.0)
Sets the identity (or event source on Windows) to use when logging to the syslog.
wrapper.syslog.ident.enable (3.5.28)
Ensures whether the event source should exist or not in the Windows registry.
wrapper.syslog.local.host (3.5.0)
Specifies the local host name included in the packets sent to a remote syslog.
wrapper.syslog.loglevel (2.2.5)
Filters messages sent to the syslog (or event log on Windows) according to their log levels.
wrapper.syslog.remote.host (3.5.0)
Specifies the host name of a remote syslog server where log outputs should be redirected to.
wrapper.syslog.remote.port (3.5.0)
Specifies the port that the remote syslog server is listening on.
wrapper.syslog.split_messages (3.5.24)
Forces messages to be broken up into individual lines making them easier to read.

[T]

wrapper.test.no_jvm (3.5.35)
Runs the Wrapper without launching a JVM.
wrapper.thread_count_delay (3.2.0, deprecated as of 3.2.1)
wrapper.thread_dump_control_code (3.3.0)
Specifies the user defined control code that can be sent to the Windows service to initiate a thread dump.
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.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.

[U]

wrapper.ulimit.data.hard (3.5.33)
Specifies the hard limit for the data segment size.
wrapper.ulimit.data.soft (3.5.33)
Specifies the soft limit for the data segment size.
wrapper.ulimit.data.strict (3.5.33)
Stops the Wrapper if the limits of the data segment size are not properly configured.
wrapper.ulimit.loglevel (3.5.31)
Controls at which log level resource limits will be logged.
wrapper.ulimit.nofile.hard (3.5.31)
Specifies the hard limit for the number of file descriptors.
wrapper.ulimit.nofile.soft (3.5.31)
Specifies the soft limit for the number of file descriptors.
wrapper.ulimit.nofile.strict (3.5.31)
Stops the Wrapper if the limits for the number of file descriptors are not properly configured.
wrapper.umask (3.2.0)
Sets the permissions on certain files created by the Wrapper.
wrapper.use_javaio_thread (3.5.8)
Controls if the Wrapper should use a dedicated thread to process console output from the JVM.
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.

[W]

wrapper.working.dir (3.1.0)
Sets the path to the working directory.
wrapper.wait_for_hostid (3.4.0) ( Std/Pro )
Enables the Wrapper to wait for the HostId at startup.

Configuration Properties:

Supported:

Debugging:

Help Pages:

Currently logged on:

Customers

Configuration Property Overview

Note

Property List by Category

Property List by Name