InitParameters (Vaadin Platform (vaadin-platform-javadoc) 14.3.7 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`	`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`	`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`	`REQUIRE_HOME_NODE_EXECUTABLE` Configuration parameter name for requiring node executable installed in home directory.
`static String`	`SERVLET_PARAMETER_BOWER_MODE` Deprecated. the parameter is renamed to `SERVLET_PARAMETER_COMPATIBILITY_MODE`
`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` enable it if your project is a Polymer 2.0 one, should be removed in V15
`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_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_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`	`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
```
public static final String SERVLET_PARAMETER_COMPATIBILITY_MODE
```
    enable it if your project is a Polymer 2.0 one, should be removed in V15
    
    See Also:
    
    Constant Field Values
  - SERVLET_PARAMETER_BOWER_MODE
```
@Deprecated
public static final String SERVLET_PARAMETER_BOWER_MODE
```
    Deprecated. the parameter is renamed to SERVLET_PARAMETER_COMPATIBILITY_MODE
    
    enable it if your project is a Polymer 2.0 one, should be removed in V15
    
    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_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
  - 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
- 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_JSBUNDLE

SERVLET_PARAMETER_POLYFILLS

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

Constructor Detail

InitParameters