• wrapper.app.parameter.<n> property
• wrapper.app.parameter.<n>.stripquotes property
• wrapper.app.parameter.default.stripquotes property
• wrapper.app.parameter_file property
• wrapper.app.parameter_file.required property
• wrapper.app.parameter_file.stripquotes 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.

Quotes:

For each entry, you can also have a corresponding strip quotes flag (stripquotes property = TRUE), which will remove unescaped quotes from the element when run on Linux/UNIX machines. This is necessary to allow for file references that contain spaces. For parameters like the one below, it would not otherwise be possible to decide when to remove quotes and when to leave them alone. All other characters except for the following will remain unchanged.

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

wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperSimpleApp
wrapper.app.parameter.1=com.widgetsrus.MyAppMain
wrapper.app.parameter.2=-d
wrapper.app.parameter.3=-c"../conf/myapp.conf"
wrapper.app.parameter.3.stripquotes=TRUE
wrapper.app.parameter.4=-p4

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

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

Compatibility :	3.5.17
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
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 :

In certain cases, it can be inconvenient to list up your application parameters in the Wrapper configuration file. This property provides a way to specify a file that can contain one or more parameters that will be passed as is to the JVM when it is launched. 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.

Parameter 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.
• Multiple parameters can be written in one line by separating each parameter with one or more spaces.
• It is also possible to break the parameters into multiple lines.
• 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.
• 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.

#encoding=UTF-8
# Example parameters: Multiple parameters in one line
-DTEST1=Value1 -DTEST2=Value2

# More parameters
-DTEST3=Value3

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

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

  Set the parameters of your Java application.

• wrapper.app.parameter.<n>.stripquotes (3.5.17)

  Strip the quotes in the application parameters (Unix only).

• wrapper.app.parameter.default.stripquotes (3.5.17)

  Strips the quotes for all "app.parameter" properties (Unix only).

• wrapper.app.parameter_file (3.5.17)

  Specifies the path of the file containing the application parameters.

• wrapper.app.parameter_file.required (3.5.17)

  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.

• 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_file (3.5.57)

  Specifies the path of the file containing the application properties.

• 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>.stripquotes (1.0.0)

  Strip the quotes in the JVM parameters (Unix only).

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