• wrapper.app.parameter.<n> property
• wrapper.app.parameter.<n>.quotable property
• wrapper.app.parameter.<n>.stripquotes property (No longer used as of 3.6.0)
• wrapper.app.parameter.default.stripquotes property (No longer used as of 3.6.0)
• wrapper.app.parameter_file property
• wrapper.app.parameter_file.required property
• wrapper.app.parameter_file.quotable property
• wrapper.app.parameter_file.stripquotes property (No longer used as of 3.6.0)
• wrapper.app.parameter.backend property

Compatibility :	1.0.0
Editions :
Platforms :

These properties are used to specify the parameters that will be passed to your application's main method.

When the value of the wrapper.java.mainclass property is org.tanukisoftware.wrapper.WrapperSimpleApp, the first parameter to the application must be the name of the class that contains your main method. All other parameters are then passed to your application's main method in order. Please see the Integration section for more details.

<n> component:

Each element has a property name that starts with wrapper.app.parameter. and the "<n>" component of the property name is an integer number counting up from "1". By default, there can be no missing numbers. The wrapper.ignore_sequence_gaps property can optionally be set to allow gaps in the sequence.

Individual parameter entry:

It is important that each property only define a single parameter.

wrapper.app.parameter.1=-c conf/myconffile.conf

wrapper.app.parameter.1=-c
wrapper.app.parameter.2=conf/myconffile.conf

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 parameter value exactly as you intend it to be received by the Java application.

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:

• '\\' will become '\',
• '\"' will become '"'
• '"' will become ''

wrapper.app.parameter.1="  my arg"
wrapper.app.parameter.1.quotable=TRUE

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

• '\\' will become '\',
• '\"' will become '"'
• '"' will become ''

Compatibility :	3.6.0
Editions :
Platforms :

If a parameter value needs to include leading or trailing spaces, you can preserve them by enclosing the value in quotation marks. These quotation marks will be stripped if you set the corresponding wrapper.app.parameter.<n>.quotable property to TRUE.

The default value for this property is "FALSE".

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.

• '\\' will become '\',
• '\"' will become '"'
• '"' will become ''

wrapper.app.parameter.1="  param1"
wrapper.app.parameter.1.quotable=TRUE
wrapper.app.parameter.2="  param2 with\"quotes\""
wrapper.app.parameter.2.quotable=TRUE

Compatibility :	3.5.17 (No longer used as of 3.6.0)
Editions :
Platforms :

If a wrapper.app.parameter.<n> value contains quotes, then the contents of the quotes will be passed to the Java Application as a single argument on Windows. However on UNIX, the quotes will also be included as part of the argument value. In most cases, this is not correct behavior on UNIX, but it is this way to maintain backwards compatibility.

The wrapper.app.parameter.<n>.stripquotes property makes it possible to tell the Wrapper to automatically strip those extra quotes on UNIX. The property is ignored on Windows.

Defaults to the value of the wrapper.app.parameter.default.stripquotes property, which itself defaults to "FALSE".

The following replacements will be made when stripping quotes. All other characters will remain unchanged.

• '\\' will become '\',
• '\"' will become '"'
• '"' will become ''

wrapper.app.parameter.1="parm1"
wrapper.app.parameter.1.stripquotes=TRUE
wrapper.app.parameter.2=parm=\"value\"
wrapper.app.parameter.2.stripquotes=TRUE

Compatibility :	3.5.17 (No longer used as of 3.6.0)
Editions :
Platforms :

Makes it possible to change the default strip quotes behavior on UNIX when you wish to have the same behavior for all wrapper.app.parameter.<n> property values. The default value is "FALSE". The property is ignored on Windows.

wrapper.app.parameter.default.stripquotes=FALSE

Compatibility :	3.5.17
Editions :
Platforms :

This property provides a way to specify a file that can contain one or more parameters 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.app.parameter.<n> properties.

Starting with Wrapper version 3.5.23, any environment variable references in the file will be expanded.

File Format:

The file format is simple.

• It must start with an encoding directive line just like the Wrapper configuration file. This is needed to tell the Wrapper what encoding to use when reading the file. If this line is missing, then the Wrapper will attempt to proceed after logging a warning. The encoding used in the file may be different from the encoding used in other configuration files.
• 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.
• By default, any non-empty line that is not a comment will be interpreted as a parameter whose value spans the entire line. This behavior can be changed by setting the wrapper.app.parameter_file.quotable property to TRUE. In this mode, arguments are delimited by any unquoted spaces. This allows multiple parameters to be listed on the same line. Values containing spaces must be quoted.

@encoding=UTF-8
# Example parameters: One parameter per line
param1
param2 with space
param3
param4

@encoding=UTF-8
# Example parameters: Multiple parameters in one line
param1 "param2 with space" param3

# More parameters
param4

Compatibility :	3.5.36
Editions :
Platforms :

Specifies if the parameter 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.app.parameter_file.required=FALSE

Compatibility :	3.6.0
Editions :
Platforms :

When set to TRUE, the quotes contained in the parameter file will be stripped. This allows you to use quotes as delimiters for values and thus list multiple parameters on a single line.

Also, quotes can be used as delimiters to retain leading or trailing spaces in parameter values.

The default value for this property is "FALSE".

"parameter 1" "parameter 2" parameter3

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.

• '\\' will become '\',
• '\"' will become '"'
• '"' will become ''

wrapper.app.parameter_file.quotable=TRUE

@encoding=UTF-8
-DTEST1=Value1 -DTEST2="Test Value with spaces."

Compatibility :	3.5.17 (No longer used as of 3.6.0)
Editions :
Platforms :

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

wrapper.app.parameter_file.stripquotes=FALSE

@encoding=UTF-8
-DTEST1=Value1 -DTEST2="Test Value with spaces."

Compatibility :	3.6.0
Editions :
Platforms :

This property can be set to TRUE to pass application parameters via the backend instead of the command line.

If any application parameters contain sensitive data, the Wrapper will require this property to be set to TRUE to prevent the data from appearing on the command line.

The default value is "FALSE".

wrapper.app.parameter.backend=TRUE

• wrapper.app.parameter.<n> (1.0.0)

  Set the parameters of your Java application.

• wrapper.app.parameter.<n>.quotable (3.6.0)

  Allows to use quotes as delimiters in application parameters.

• wrapper.app.parameter.backend (3.6.0)

  Allows application parameters to be passed through the backend instead of the command line.

• wrapper.app.parameter_file (3.5.17)

  Specifies the path of the file containing the application parameters.

• wrapper.app.parameter_file.quotable (3.6.0)

  Allows to use quotes as delimiters for values listed in the "parameter file".

• wrapper.app.parameter_file.required (3.5.17)

  Specifies if the parameter file is required or not.

• wrapper.app.property.<n> (3.5.57)

  Configure application specific properties to be sent via pipe or socket.

• wrapper.app.property.<n>.java_version.min (3.5.57) ( Std/Pro )

  Append application property with index 'n' only if the Java version is greater than or equal to the specified value.

• wrapper.app.property.<n>.java_version.max (3.5.57) ( Std/Pro )

  Append application property with index 'n' only if the Java version is lower than or equal to the specified value.

• wrapper.app.property.<n>.quotable (3.6.0)

  Allows to use quotes as delimiters in application properties.

• wrapper.app.property_file (3.5.57)

  Specifies the path of the file containing the application properties.

• wrapper.app.property_file.quotable (3.6.0)

  Allows to use quotes as delimiters for values listed in the "property file".

• wrapper.app.property_file.required (3.5.57)

  Specifies if the property file is required or not.

• 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>.quotable (3.6.0)

  Allows to use quotes as delimiters in JVM parameters.

• wrapper.java.additional_file (3.5.16)

  Sets the path to a file containing JVM parameters.

• wrapper.java.additional_file.quotable (3.6.0)

  Allows to use quotes as delimiters for values listed in the "additional file".

• wrapper.java.additional_file.required (3.5.36)

  Specifies if the Java additional file is required or not.

• wrapper.java.mainclass (1.0.0)

  Sets the class holding the main method called when the Wrapper starts the JVM.

• wrapper.java.tmpdir.<x> (3.5.0)
• 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.