InitParameters (Flow Server 2.13-SNAPSHOT API)

java.lang.Object
- com.vaadin.flow.server.InitParameters

All Implemented Interfaces:

Serializable
```
public class InitParameters
extends Object
implements Serializable
```
Constants for all servlet init parameters. Keeping them in a separate class allows using reflection to expose the parameters in the Spring add-on.
Note: do not add other constants than String constants representing init parameters here.

Since:

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APPLICATION_PARAMETER_DEVMODE_ENABLE_COMPONENT_TRACKER` Configuration parameter name for enabling component tracking in development mode.
`static String`	`CI_BUILD` Configuration name for enabling ci build for npm/pnpm.
`static String`	`COMPILED_WEB_COMPONENTS_PATH` Configuration name for the parameter that sets the compiled web components path.
`static String`	`DISABLE_AUTOMATIC_SERVLET_REGISTRATION` Configuration name for the parameter that determines if Flow should automatically register servlets needed for the application to work.
`static String`	`DISABLE_WEBJARS` Configuration name for the parameter that determines if Flow should use webJars or not.
`static String`	`ENFORCE_FIELD_VALIDATION` A property that enforces full experience validation for Flow components.
`static String`	`EXTERNAL_STATS_FILE` Property boolean for marking stats.json to be fetched from external location.
`static String`	`EXTERNAL_STATS_URL` Property String for external stats.json location url.
`static String`	`FRONTEND_URL_ES5` Configuration name for the frontend URL prefix for ES5.
`static String`	`FRONTEND_URL_ES6` Configuration name for the frontend URL prefix for ES6.
`static String`	`I18N_PROVIDER` I18N provider property.
`static String`	`LOAD_ES5_ADAPTERS` Configuration name for loading the ES5 adapters.
`static String`	`NODE_DOWNLOAD_ROOT`
`static String`	`NODE_VERSION`
`static String`	`REQUIRE_HOME_NODE_EXECUTABLE` Configuration parameter name for requiring node executable installed in home directory.
`static String`	`SERVLET_PARAMETER_BOWER_MODE` Deprecated. Bower WebJars are no longer supported.
`static String`	`SERVLET_PARAMETER_BROTLI` Configuration name for the parameter that determines whether Brotli compression should be used for static resources in cases when a precompressed file is available.
`static String`	`SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS`
`static String`	`SERVLET_PARAMETER_COMPATIBILITY_MODE` Deprecated. Bower WebJars are no longer supported.
`static String`	`SERVLET_PARAMETER_DEVMODE_ENABLE_LIVE_RELOAD` Configuration parameter name for enabling live reload.
`static String`	`SERVLET_PARAMETER_DEVMODE_OPTIMIZE_BUNDLE` Boolean parameter for enabling/disabling bytecode scanning in dev mode.
`static String`	`SERVLET_PARAMETER_DEVMODE_TRANSPILE` Boolean parameter for enabling/disabling transpilation for IE11 with the BabelMultiTargetPlugin in dev mode.
`static String`	`SERVLET_PARAMETER_DEVMODE_WEBPACK_ERROR_PATTERN` Configuration name for the pattern used to inspect the webpack output to detecting when compilation failed.
`static String`	`SERVLET_PARAMETER_DEVMODE_WEBPACK_OPTIONS` Configuration name for adding extra options to the webpack-dev-server.
`static String`	`SERVLET_PARAMETER_DEVMODE_WEBPACK_SUCCESS_PATTERN` Configuration name for the pattern used to inspect the webpack output to assure it is up and running.
`static String`	`SERVLET_PARAMETER_DEVMODE_WEBPACK_TIMEOUT` Configuration name for the time waiting for webpack output success or error pattern defined in `Constants.SERVLET_PARAMETER_DEVMODE_WEBPACK_SUCCESS_PATTERN` and `Constants.SERVLET_PARAMETER_DEVMODE_WEBPACK_ERROR_PATTERN` parameters.
`static String`	`SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION`
`static String`	`SERVLET_PARAMETER_ENABLE_DEV_SERVER`
`static String`	`SERVLET_PARAMETER_ENABLE_OLD_LICENSE_CHECKER` Configuration parameter name for enabling old JavaScript license checker and disable server-side and offline license checker features.
`static String`	`SERVLET_PARAMETER_ENABLE_PNPM` Configuration parameter name for enabling pnpm.
`static String`	`SERVLET_PARAMETER_HEARTBEAT_INTERVAL`
`static String`	`SERVLET_PARAMETER_JSBUNDLE`
`static String`	`SERVLET_PARAMETER_MAX_MESSAGE_SUSPEND_TIMEOUT`
`static String`	`SERVLET_PARAMETER_MAX_REQUEST_BODY_SIZE` Configuration parameter name for the maximum size, in characters, that Flow reads from a client-to-server UIDL/RPC or push request body before rejecting the request with HTTP 413 (Request Entity Too Large).
`static String`	`SERVLET_PARAMETER_POLYFILLS`
`static String`	`SERVLET_PARAMETER_PRODUCTION_MODE`
`static String`	`SERVLET_PARAMETER_PUSH_MODE`
`static String`	`SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING`
`static String`	`SERVLET_PARAMETER_PUSH_URL`
`static String`	`SERVLET_PARAMETER_REQUEST_TIMING`
`static String`	`SERVLET_PARAMETER_REUSE_DEV_SERVER`
`static String`	`SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS`
`static String`	`SERVLET_PARAMETER_STATISTICS_JSON` Configuration name for the WebPack profile statistics json file to use to determine template contents.
`static String`	`SERVLET_PARAMETER_SYNC_ID_CHECK`
`static String`	`SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT`
`static String`	`UI_PARAMETER` The name of the parameter that is by default used in e.g.
`static String`	`URL_SAFE_SCHEMES` Configuration name for the comma-separated list of URL schemes that are considered safe in URLs set on components such as `Anchor`, `IFrame` and in `Page.open(String, String)`.
`static String`	`USE_ORIGINAL_FRONTEND_RESOURCES` Configuration name for the parameter that determines if Flow should use bundled fragments or not.

Constructor Summary

Constructors
Constructor and Description

InitParameters()

Constructors
Constructor and Description
`InitParameters()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UI_PARAMETER
```
public static final String UI_PARAMETER
```
    The name of the parameter that is by default used in e.g. web.xml to define the name of the default UI class.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_PRODUCTION_MODE
```
public static final String SERVLET_PARAMETER_PRODUCTION_MODE
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_COMPATIBILITY_MODE
```
@Deprecated
public static final String SERVLET_PARAMETER_COMPATIBILITY_MODE
```
    Deprecated. Bower WebJars are no longer supported.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_BOWER_MODE
```
@Deprecated
public static final String SERVLET_PARAMETER_BOWER_MODE
```
    Deprecated. Bower WebJars are no longer supported.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_ENABLE_DEV_SERVER
```
public static final String SERVLET_PARAMETER_ENABLE_DEV_SERVER
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_REUSE_DEV_SERVER
```
public static final String SERVLET_PARAMETER_REUSE_DEV_SERVER
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_REQUEST_TIMING
```
public static final String SERVLET_PARAMETER_REQUEST_TIMING
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION
```
public static final String SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_HEARTBEAT_INTERVAL
```
public static final String SERVLET_PARAMETER_HEARTBEAT_INTERVAL
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT
```
public static final String SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS
```
public static final String SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_PUSH_MODE
```
public static final String SERVLET_PARAMETER_PUSH_MODE
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_PUSH_URL
```
public static final String SERVLET_PARAMETER_PUSH_URL
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_SYNC_ID_CHECK
```
public static final String SERVLET_PARAMETER_SYNC_ID_CHECK
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS
```
public static final String SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING
```
public static final String SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_MAX_MESSAGE_SUSPEND_TIMEOUT
```
public static final String SERVLET_PARAMETER_MAX_MESSAGE_SUSPEND_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_MAX_REQUEST_BODY_SIZE
```
public static final String SERVLET_PARAMETER_MAX_REQUEST_BODY_SIZE
```
    Configuration parameter name for the maximum size, in characters, that Flow reads from a client-to-server UIDL/RPC or push request body before rejecting the request with HTTP 413 (Request Entity Too Large). The default is 10 MB; set the value to -1 to disable the limit.
    This limit does not apply to file uploads, which are streamed in chunks and have their own separate size limits (request size, file size and file count).
    The body is read incrementally and the limit is enforced on the running total, so the request is rejected mid-stream once the limit is exceeded; even chunked (Transfer-Encoding: chunked) requests without a Content-Length header cannot bypass it. For this to hold, Flow must be the first component to read the body: if a filter or request wrapper in front of Flow buffers the whole body first, that memory cost is incurred before this check runs. As defense-in-depth, also configure a request body size limit and a request read timeout at the servlet container or reverse proxy (for example Tomcat connectionTimeout and maxSwallowSize, or nginx client_max_body_size and client_body_timeout).
    Be careful not to set the limit too low: every Flow interaction adds a small protocol overhead (roughly 100 bytes per request on top of the actual payload), and request bodies also grow with the size of component state changes and RPC arguments sent from the browser. A limit that is too low will reject legitimate interactions and make the application unusable. Choose a value that comfortably accommodates the largest expected UIDL/RPC payload produced by the application.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_JSBUNDLE
```
public static final String SERVLET_PARAMETER_JSBUNDLE
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_POLYFILLS
```
public static final String SERVLET_PARAMETER_POLYFILLS
```
    See Also:
    
    Constant Field Values
  - NODE_VERSION
```
public static final String NODE_VERSION
```
    See Also:
    
    Constant Field Values
  - NODE_DOWNLOAD_ROOT
```
public static final String NODE_DOWNLOAD_ROOT
```
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_BROTLI
```
public static final String SERVLET_PARAMETER_BROTLI
```
    Configuration name for the parameter that determines whether Brotli compression should be used for static resources in cases when a precompressed file is available.
    
    See Also:
    
    Constant Field Values
  - LOAD_ES5_ADAPTERS
```
public static final String LOAD_ES5_ADAPTERS
```
    Configuration name for loading the ES5 adapters.
    
    See Also:
    
    Constant Field Values
  - FRONTEND_URL_ES6
```
public static final String FRONTEND_URL_ES6
```
    Configuration name for the frontend URL prefix for ES6.
    
    See Also:
    
    Constant Field Values
  - FRONTEND_URL_ES5
```
public static final String FRONTEND_URL_ES5
```
    Configuration name for the frontend URL prefix for ES5.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_STATISTICS_JSON
```
public static final String SERVLET_PARAMETER_STATISTICS_JSON
```
    Configuration name for the WebPack profile statistics json file to use to determine template contents.
    File needs to be available either for the ClassLoader as a resource, or as a static web resource. By default it returns the value in Constants.STATISTICS_JSON_DEFAULT
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_DEVMODE_WEBPACK_TIMEOUT
```
public static final String SERVLET_PARAMETER_DEVMODE_WEBPACK_TIMEOUT
```
    Configuration name for the time waiting for webpack output success or error pattern defined in Constants.SERVLET_PARAMETER_DEVMODE_WEBPACK_SUCCESS_PATTERN and Constants.SERVLET_PARAMETER_DEVMODE_WEBPACK_ERROR_PATTERN parameters.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_DEVMODE_WEBPACK_SUCCESS_PATTERN
```
public static final String SERVLET_PARAMETER_DEVMODE_WEBPACK_SUCCESS_PATTERN
```
    Configuration name for the pattern used to inspect the webpack output to assure it is up and running. Default value is defined in DevModeHandler as the : Compiled expression.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_DEVMODE_WEBPACK_ERROR_PATTERN
```
public static final String SERVLET_PARAMETER_DEVMODE_WEBPACK_ERROR_PATTERN
```
    Configuration name for the pattern used to inspect the webpack output to detecting when compilation failed. Default value is defined in DevModeHandler as the : Failed expression.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_DEVMODE_WEBPACK_OPTIONS
```
public static final String SERVLET_PARAMETER_DEVMODE_WEBPACK_OPTIONS
```
    Configuration name for adding extra options to the webpack-dev-server.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_DEVMODE_OPTIMIZE_BUNDLE
```
public static final String SERVLET_PARAMETER_DEVMODE_OPTIMIZE_BUNDLE
```
    Boolean parameter for enabling/disabling bytecode scanning in dev mode. If enabled, entry points are scanned for reachable frontend resources. If disabled, all classes on the classpath are scanned.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_ENABLE_PNPM
```
public static final String SERVLET_PARAMETER_ENABLE_PNPM
```
    Configuration parameter name for enabling pnpm.
    
    Since:
    
    2.2
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_DEVMODE_ENABLE_LIVE_RELOAD
```
public static final String SERVLET_PARAMETER_DEVMODE_ENABLE_LIVE_RELOAD
```
    Configuration parameter name for enabling live reload.
    
    Since:
    
    See Also:
    
    Constant Field Values
  - I18N_PROVIDER
```
public static final String I18N_PROVIDER
```
    I18N provider property.
    
    See Also:
    
    Constant Field Values
  - DISABLE_AUTOMATIC_SERVLET_REGISTRATION
```
public static final String DISABLE_AUTOMATIC_SERVLET_REGISTRATION
```
    Configuration name for the parameter that determines if Flow should automatically register servlets needed for the application to work.
    
    See Also:
    
    Constant Field Values
  - REQUIRE_HOME_NODE_EXECUTABLE
```
public static final String REQUIRE_HOME_NODE_EXECUTABLE
```
    Configuration parameter name for requiring node executable installed in home directory.
    
    Since:
    
    See Also:
    
    Constant Field Values
  - COMPILED_WEB_COMPONENTS_PATH
```
public static final String COMPILED_WEB_COMPONENTS_PATH
```
    Configuration name for the parameter that sets the compiled web components path. The path should be the same as webComponentOutputDirectoryName in the maven plugin that transpiles ES6 code. This path is only used for generated web components (server side web components) module in case they are transpiled: web component UI imports them as dependencies.
    
    See Also:
    
    Constant Field Values
  - DISABLE_WEBJARS
```
public static final String DISABLE_WEBJARS
```
    Configuration name for the parameter that determines if Flow should use webJars or not.
    
    See Also:
    
    Constant Field Values
  - USE_ORIGINAL_FRONTEND_RESOURCES
```
public static final String USE_ORIGINAL_FRONTEND_RESOURCES
```
    Configuration name for the parameter that determines if Flow should use bundled fragments or not.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_DEVMODE_TRANSPILE
```
public static final String SERVLET_PARAMETER_DEVMODE_TRANSPILE
```
    Boolean parameter for enabling/disabling transpilation for IE11 with the BabelMultiTargetPlugin in dev mode.
    
    See Also:
    
    Constant Field Values
  - EXTERNAL_STATS_FILE
```
public static final String EXTERNAL_STATS_FILE
```
    Property boolean for marking stats.json to be fetched from external location.
    
    See Also:
    
    Constant Field Values
  - EXTERNAL_STATS_URL
```
public static final String EXTERNAL_STATS_URL
```
    Property String for external stats.json location url.
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_ENABLE_OLD_LICENSE_CHECKER
```
public static final String SERVLET_PARAMETER_ENABLE_OLD_LICENSE_CHECKER
```
    Configuration parameter name for enabling old JavaScript license checker and disable server-side and offline license checker features.
    Compatibility/Bower mode always uses old license checking.
    
    Since:
    
    2.8
    
    See Also:
    
    Constant Field Values
  - CI_BUILD
```
public static final String CI_BUILD
```
    Configuration name for enabling ci build for npm/pnpm.
    
    See Also:
    
    Constant Field Values
  - ENFORCE_FIELD_VALIDATION
```
public static final String ENFORCE_FIELD_VALIDATION
```
    A property that enforces full experience validation for Flow components.
    The full experience validation integrates web component's own validation, server-side component's constraints and Binder validation into a seamless chain. By default, it's disabled, which means that components aren't validated on blur, for example.
    For more detailed information, please refer to: https://github.com/vaadin/platform/issues/3066#issuecomment-1598771284
    
    See Also:
    
    Constant Field Values
  - APPLICATION_PARAMETER_DEVMODE_ENABLE_COMPONENT_TRACKER
```
public static final String APPLICATION_PARAMETER_DEVMODE_ENABLE_COMPONENT_TRACKER
```
    Configuration parameter name for enabling component tracking in development mode. If not set, tracking is enabled by default.
    
    Since:
    
    See Also:
    
    Constant Field Values
  - URL_SAFE_SCHEMES
```
public static final String URL_SAFE_SCHEMES
```
    Configuration name for the comma-separated list of URL schemes that are considered safe in URLs set on components such as Anchor, IFrame and in Page.open(String, String).
    When not set, a built-in default set of safe schemes is used (for example http, https, mailto, tel and ftp), which excludes script-capable schemes such as javascript and data. Any entry equal to * marks every scheme as safe, disabling scheme validation. URLs whose scheme is not safe can still be set through the dedicated setUnsafe* methods.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - InitParameters
```
public InitParameters()
```

Class InitParameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UI_PARAMETER

SERVLET_PARAMETER_PRODUCTION_MODE

SERVLET_PARAMETER_COMPATIBILITY_MODE

SERVLET_PARAMETER_BOWER_MODE

SERVLET_PARAMETER_ENABLE_DEV_SERVER

SERVLET_PARAMETER_REUSE_DEV_SERVER

SERVLET_PARAMETER_REQUEST_TIMING

SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION

SERVLET_PARAMETER_HEARTBEAT_INTERVAL

SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT

SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS

SERVLET_PARAMETER_PUSH_MODE

SERVLET_PARAMETER_PUSH_URL

SERVLET_PARAMETER_SYNC_ID_CHECK

SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS

SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING

SERVLET_PARAMETER_MAX_MESSAGE_SUSPEND_TIMEOUT

SERVLET_PARAMETER_MAX_REQUEST_BODY_SIZE

SERVLET_PARAMETER_JSBUNDLE

SERVLET_PARAMETER_POLYFILLS

NODE_VERSION

NODE_DOWNLOAD_ROOT

SERVLET_PARAMETER_BROTLI

LOAD_ES5_ADAPTERS

FRONTEND_URL_ES6

FRONTEND_URL_ES5

SERVLET_PARAMETER_STATISTICS_JSON

SERVLET_PARAMETER_DEVMODE_WEBPACK_TIMEOUT

SERVLET_PARAMETER_DEVMODE_WEBPACK_SUCCESS_PATTERN

SERVLET_PARAMETER_DEVMODE_WEBPACK_ERROR_PATTERN

SERVLET_PARAMETER_DEVMODE_WEBPACK_OPTIONS

SERVLET_PARAMETER_DEVMODE_OPTIMIZE_BUNDLE

SERVLET_PARAMETER_ENABLE_PNPM

SERVLET_PARAMETER_DEVMODE_ENABLE_LIVE_RELOAD

I18N_PROVIDER

DISABLE_AUTOMATIC_SERVLET_REGISTRATION

REQUIRE_HOME_NODE_EXECUTABLE

COMPILED_WEB_COMPONENTS_PATH

DISABLE_WEBJARS

USE_ORIGINAL_FRONTEND_RESOURCES

SERVLET_PARAMETER_DEVMODE_TRANSPILE

EXTERNAL_STATS_FILE

EXTERNAL_STATS_URL

SERVLET_PARAMETER_ENABLE_OLD_LICENSE_CHECKER

CI_BUILD

ENFORCE_FIELD_VALIDATION

APPLICATION_PARAMETER_DEVMODE_ENABLE_COMPONENT_TRACKER

URL_SAFE_SCHEMES

Constructor Detail

InitParameters