Index

wrapper.app.property.<n>

Compatibility :3.5.57
Editions :Professional EditionStandard EditionCommunity Edition
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

List of application specific properties that are sent from the Wrapper to the JVM via the backend pipe or socket once the connection is established.

The user application will be launched after all properties have been received and set on the Java side. This ensures that all properties will be available when the application starts.

Using the wrapper.app.property.<n> properties is more secure than setting wrapper.java.additional.<n>, which expose them in plain text to process listing tools. For this reason, it is strongly recommended to use application properties for passwords or any sensitive data that your application may use.

To protect data stored in your configuration file, a best practice is to isolate the wrapper.app.property.<n> properties containing sensitive values in a separate "include file" and assign it with restrictive read permissions (e.g for admin or owner only).

In addition, to prevent passwords or sensitive data to be printed as plain text in the Wrapper log output, please use the %...|mask% syntax.

<n> component:
Each element has a property name which starts with "wrapper.app.property." and the "<n>" component of the property name is an integer number counting up from "1". By default the numbering should be in sequence without gaps". The wrapper.ignore_sequence_gaps property can optionally be set to allow gaps in the sequence.

Example:
wrapper.app.property.1=mypassword=%secret|mask%

WARNING

Unlike properties set via the Java command line, which are available as soon as the JVM is launched, these properties are only set after being received through the backend channel created by the Wrapper. Properties referenced with wrapper.app.property.<n> are therefore intended to be used only within the context of your Java Application.

Several system classes are loaded before the backend channel is created. If a system property is to be used by one of these classes, it must be referenced in the wrapper.java.additional.<n> so that it is passed as command line arguments.

wrapper.app.property.<n>.java_version.min

Compatibility :3.5.57
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

This property can be used to append the property 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.

Option with index 'n' is ignored for any Java version lower than 1.7:
wrapper.app.property.<n>.java_version.min=1.7
Option with index 'n' is ignored for any Java version lower than 8.0.40:
wrapper.app.property.<n>.java_version.min=8.0.40

WARNING

wrapper.app.property.<n>.java_version.max

Compatibility :3.5.57
Editions :Professional EditionStandard EditionCommunity Edition (Not Supported)
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

This property can be used to append the property 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.

Option with index 'n' is ignored for any Java version greater than 9.0.1:
wrapper.app.property.<n>.java_version.max=9.0.1
Option with index 'n' is ignored for any Java version greater than 9:
wrapper.app.property.<n>.java_version.max=9

WARNING

wrapper.app.property_file

Compatibility :3.5.57
Editions :Professional EditionStandard EditionCommunity Edition
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

In certain cases, it can be inconvenient to list up your application properties in the Wrapper configuration file. This property provides a way to specify a file that can contain one or more properties to be passed to your Java application. This can be very useful when the property list needs to be generated dynamically or via an installer.

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.
  • Unlike for wrapper.java.additional_file and wrapper.app.parameter_file, this file can only contain one property per line.
  • 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.
Example of Parameter File UTF-8:
#encoding=UTF-8
# Some properties
prop1=value
prop2=value with spaces

wrapper.app.property_file.required

Compatibility :3.5.57
Editions :Professional EditionStandard EditionCommunity Edition
Platforms :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

Specifies if the property 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.

Example:
wrapper.app.property_file.required=FALSE

Reference: Parameters