Index

wrapper.app.property.<n>

Compatibilidad :3.5.57
Ediciones :Edición ProfesionaEdición EstándarEdición de la Comunidad
Plataformas :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%

ADVERTENCIA

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

Compatibilidad :3.6.0
Ediciones :Edición ProfesionaEdición EstándarEdición de la Comunidad
Plataformas :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

If a property value needs to include 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.property.<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 ''
Example:
wrapper.app.property.1=prop1="value with trailing spaces   "
wrapper.app.property.1.quotable=TRUE

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

Compatibilidad :3.5.57
Ediciones :Edición ProfesionaEdición EstándarEdición de la Comunidad (No Compatible)
Plataformas :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

ADVERTENCIA

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

Compatibilidad :3.5.57
Ediciones :Edición ProfesionaEdición EstándarEdición de la Comunidad (No Compatible)
Plataformas :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

ADVERTENCIA

wrapper.app.property_file

Compatibilidad :3.5.57
Ediciones :Edición ProfesionaEdición EstándarEdición de la Comunidad
Plataformas :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

This property provides a way to specify a file that can contain one or more properties to be passed to the Java application. This can be very useful when the property list needs to be generated dynamically or via an installer.

Any property defined in this file will appear after those defined using the standard wrapper.app.property.<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, only one property can be written per line. This behavior can be changed by setting the wrapper.app.property_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 that contain spaces must be enclosed in quotes; these quotes will be removed during file parsing.

Example of Property File (with .quotable=FALSE):
@encoding=UTF-8
# Example properties: One property per line
prop1=Value1
prop2=Value2 with space
prop3=Value3 with space
prop4=Value4

Example of Property File (with .quotable=TRUE):
@encoding=UTF-8
# Example properties: Multiple properties in one line
prop1=Value1 prop2="Value2 with space" "prop3=Value3 with space"

# More arguments
prop4=Value4

NOTA

Versions 3.5.57 to 3.5.60 don't have the "quotable" mode. The file can only contain one property per line and quotes are not stripped.

wrapper.app.property_file.required

Compatibilidad :3.5.57
Ediciones :Edición ProfesionaEdición EstándarEdición de la Comunidad
Plataformas :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

wrapper.app.property_file.quotable

Compatibilidad :3.6.0
Ediciones :Edición ProfesionaEdición EstándarEdición de la Comunidad
Plataformas :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/Linux

When set to TRUE, the quotes contained in the property 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 the property values.

The default value for this property is "FALSE".

NOTA

Versions 3.5.57 to 3.5.60 don't have the "quotable" mode. The file can only contain one property per line and quotes are not stripped.

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 ''
Example:
wrapper.app.property_file.quotable=TRUE
Example of Parameter File UTF-8:
@encoding=UTF-8
prop1=Value1 prop2="Test Value with spaces."

Referencia: Parámetros