Index |
|
wrapper.java.additional.<n> |
||||||||||||||
Additional Java parameters to pass to Java when it is launched. These are not parameters for your application, but rather parameters for the JVM. If you wish to dynamically change the list of additional Java parameters, there are a few ways to do so. The first is to make use of cascading include files to append a generated configuration file listing the wrapper.java.additional.<n> properties along with your JVM options. Alternatively, you may use the wrapper.java.additional_file property to reference a parameter file where you would simply list the JVM options without properties. Finally, you can pass the wrapper.java.additional.<n> as command line properties when launching the Wrapper. NOTE
For application specific properties, especially those with values containing sensitive data, consider using wrapper. <n> component:
Each element has a property name which starts with "wrapper. Individual parameter entry: It is important that each property only define a single argument.
NOTESince version 3.6.0, the following options can be separated from their arguments by a space.
Quotes: Version 3.6.0 and later Starting with version 3.6.0, the handling of special characters has changed to ensure consistency across all platforms. In most cases, you can write the argument exactly as you intend it to be received by the JVM. An exception to this is leading or trailing spaces, which are normally trimmed from property values. To preserve these spaces, it is necessary to enclose the value in quotation marks. These quotation marks will be stripped if the corresponding "quotable" property is set to TRUE. To retain actual quotes in the value, escape them with a '\' character. Backslashes must also be doubled ('\\'). No other characters are allowed to be escaped. When stripping quotes, only the the following changes will apply:
Prior to version 3.6.0 In older versions of the Wrapper, the way quotes are handled varies between platforms. On Windows, the Java process is created using a command line where arguments containing spaces must be quoted. The quotes are automatically stripped from the command line when the process is launched. On Linux, however, an array is used, and arguments are passed directly. To simulate the Windows behavior and use the same configuration across platforms, it is possible to mark certain arguments with a strip quotes flag (stripquotes property = TRUE). This flag is only used on Unix, and specifies that quotes must be stripped before passing the parameter(s) to the JVM. When stripping quotes, all other characters except for the following will remain unchanged.
|
wrapper.java.additional.<n>.stripquotes |
||||||||||
WARNINGAs of version 3.6.0 this property is no longer needed and therefore becomes invalid. Any value marked with "stripquotes" should be revised to no longer escape backslashes ('\') and quotes ('"').
If a wrapper.
The wrapper.
Defaults to the value of the wrapper. <n> component:
Each element has a property name which starts with "wrapper.
The following replacements will be made when stripping quotes. All other characters will remain unchanged.
|
wrapper.java.additional.default.stripquotes |
||||||||
WARNINGAs of version 3.6.0 this property is no longer needed and therefore becomes invalid. Any value marked with "stripquotes" should be revised to no longer escape backslashes ('\') and quotes ('"').
Makes it possible to change the default strip quotes behavior on UNIX when you wish to have the same behavior
for all wrapper.
|
wrapper.java.additional.<n>.java_version.min |
||||||||||
This property can be used to append the option with index 'n' only if the Java version is greater than or equal to the specified value. The default value is '1.4' which is the oldest JVM version supported by the Wrapper. Any lower value is invalid and will cause the Wrapper to stop. The value can be in the format '1.major[.minor[_revision]]' or 'major[.minor[.revision]]', regardless the version of Java. This is done to support both numbering schemes returned by 'java -version': prior to Java 9 the first format was used, while Java 9 and above use the second format. The brackets indicate that the minor and revision components are optional. Leaving one or both unspecified means that these placeholders will accept any number.
WARNING
|
wrapper.java.additional.<n>.java_version.max |
||||||||||
This property can be used to append the option with index 'n' only if the Java version is lower than or equal to the specified value. The default value is 'UNLIMITED'. The value can be in the format '1.major[.minor[_revision]]' or 'major[.minor[.revision]]', regardless the version of Java. This is done to support both numbering schemes returned by 'java -version': prior to Java 9 the first format was used, while Java 9 and above use the second format. The brackets indicate that the minor and revision components are optional. Leaving one or both unspecified means that these placeholders will accept any number.
WARNING
|
wrapper.java.additional.<n>.app_only |
|||||||||
WARNING
Use of this property has been deprecated as of Wrapper version 3.5.60 in favor of the
wrapper. Before launching a JVM to run the Java application, the Wrapper will execute the Java command line with a --dry-run option to check that the command line is valid.
The wrapper. This property has no effect when using versions of Java that do not support the --dry-run option (prior to Java 9). The default value is "FALSE", which means that the specified option will be present in both the real Java command line and the "--dry-run" command line. In the vast majority of cases, FALSE is preferred so that all JVM options are verified. NOTESetting this property to TRUE will bypass the validity check for the specified option.
There are a few cases where setting wrapper.
Most of the time, this warning won't be visible because the output will be logged at the level specified with the wrapper.java.query.loglevel property, which is DEBUG by default. However, it is not possible to track the native memory usage of a "--dry-run" JVM anyway because it won't run user's native code. It is therefore best not to include this option in the "--dry-run" command line.
|
wrapper.java.additional.<n>.scope |
|||||||||
WARNINGDO 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. Before launching the Java application, the Wrapper will run the java command a few times to determine the characteristics of the current Java installation and the appropriate settings for the application. In most cases, the command lines for these Java invocations are built by the Wrapper without the user having to worry about it. In a few rare scenarios, however, it may be necessary to add or remove certain options to these command lines. Let's first draw the list of these Java invocations and their roles:
The wrapper. Possible values are:
The default value is DRYRUN_APP.
|
wrapper.java.additional_file |
||||||||||
This property provides a way to specify a file that can contain one or more JVM arguments to be passed to the JVM. This can be very useful when the parameter list needs to be generated dynamically or via an installer. Any parameters defined in this file will appear after those defined using the standard wrapper.java.additional.<n> properties. Starting with Wrapper version 3.5.23, any environment variable references in the file will be expanded. NOTEYou may target different versions of Java by including the WRAPPER_JAVA_VERSION environment variable in the name of the file. File Format: The file format is simple.
NOTEVersions before 3.6.0 don't have the "quotable" mode, and multiple arguments per line are always allowed. If any of the values need to include a space, then it is necessary to add quotes following the rules described below to make sure the file works consistently across all platforms. |
wrapper.java.additional_file.required |
||||||||
Specifies if the Java additional file is required or not. If it is required and not found, the Wrapper will stop without starting the JVM. If it is not required, the file will be ignored when not found. The default value is TRUE.
|
wrapper.java.additional_file.quotable |
|||||||||||
When set to TRUE, the quotes contained in the "additional file" will be stripped. This allows you to use quotes as delimiters for values and thus list multiple arguments on a single line. Also, quotes can be used as delimiters to retain leading or trailing spaces in arguments. The default value for this property is "FALSE". WARNINGVersions before 3.6.0 don't have the "quotable" mode, and multiple arguments per line are always allowed. If any of the values need to include a space, then it is necessary to add quotes following the rules described below to make sure the file works consistently across all platforms. In the example below, the line was interpreted as three different arguments before version 3.6.0. Since version 3.6.0, they are interpreted as a single argument containing quotes, unless wrapper.java.additional_file.quotable is set to TRUE.
When a "quotable" property is set to TRUE, actual quotes to be retained in the corresponding value must then be escaped with a '\' character, and backslashes must be doubled ('\\'). No other character are allowed to be escaped. The following replacements will be made when stripping quotes.
|
wrapper.java.additional_file.stripquotes |
||||||||||
WARNINGAs of version 3.6.0 this property is no longer needed and therefore becomes invalid. Any value marked with "stripquotes" should be revised to no longer escape backslashes ('\') and quotes ('"'). Different platforms handle parameters with spaces differently. To make a given configuration work consistently, you should always quote those values. They will be used as is on Windows. However, on UNIX platforms, the quotes will be stripped as the command line is broken into a parameter list. In almost all cases, you will want to strip these quotes. The default value is "FALSE".
|
Usage Examples |
||||||
|
Reference: Parameters |
|