Package com.vaadin.flow.server

Class InitParameters

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:

  • Field Details

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

    • SERVLET_PARAMETER_PRODUCTION_MODE

      public static final String SERVLET_PARAMETER_PRODUCTION_MODE
      See Also:

    • SERVLET_PARAMETER_INITIAL_UIDL

      public static final String SERVLET_PARAMETER_INITIAL_UIDL
      See Also:

    • SERVLET_PARAMETER_ENABLE_DEV_SERVER

      @Deprecated public static final String SERVLET_PARAMETER_ENABLE_DEV_SERVER
      Deprecated.
      Enable dev server is deprecated. use FRONTEND_HOTDEPLOY
      See Also:

    • SERVLET_PARAMETER_REUSE_DEV_SERVER

      public static final String SERVLET_PARAMETER_REUSE_DEV_SERVER
      See Also:

    • SERVLET_PARAMETER_REQUEST_TIMING

      public static final String SERVLET_PARAMETER_REQUEST_TIMING
      See Also:

    • SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION

      public static final String SERVLET_PARAMETER_DISABLE_XSRF_PROTECTION
      See Also:

    • SERVLET_PARAMETER_HEARTBEAT_INTERVAL

      public static final String SERVLET_PARAMETER_HEARTBEAT_INTERVAL
      See Also:

    • SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT

      public static final String SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT
      See Also:

    • SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS

      public static final String SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS
      See Also:

    • SERVLET_PARAMETER_PUSH_MODE

      public static final String SERVLET_PARAMETER_PUSH_MODE
      See Also:

    • SERVLET_PARAMETER_SESSION_LOCK_CHECK_STRATEGY

      public static final String SERVLET_PARAMETER_SESSION_LOCK_CHECK_STRATEGY
      See Also:

    • SERVLET_PARAMETER_PUSH_SERVLET_MAPPING

      public static final String SERVLET_PARAMETER_PUSH_SERVLET_MAPPING
      See Also:

    • SERVLET_PARAMETER_SYNC_ID_CHECK

      public static final String SERVLET_PARAMETER_SYNC_ID_CHECK
      See Also:

    • SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS

      public static final String SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS
      See Also:

    • SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING

      public static final String SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING
      See Also:

    • SERVLET_PARAMETER_MAX_MESSAGE_SUSPEND_TIMEOUT

      public static final String SERVLET_PARAMETER_MAX_MESSAGE_SUSPEND_TIMEOUT
      See Also:

    • SERVLET_PARAMETER_JSBUNDLE

      public static final String SERVLET_PARAMETER_JSBUNDLE
      See Also:

    • SERVLET_PARAMETER_POLYFILLS

      public static final String SERVLET_PARAMETER_POLYFILLS
      See Also:

    • NODE_VERSION

      public static final String NODE_VERSION
      See Also:

    • NODE_DOWNLOAD_ROOT

      public static final String NODE_DOWNLOAD_ROOT
      See Also:

    • REACT_ENABLE

      public static final String REACT_ENABLE
      See Also:

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

    • SERVLET_PARAMETER_STATISTICS_JSON

      public static final String SERVLET_PARAMETER_STATISTICS_JSON
      Configuration name for the frontend 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:

    • SERVLET_PARAMETER_DEVMODE_TIMEOUT

      public static final String SERVLET_PARAMETER_DEVMODE_TIMEOUT
      Configuration name for the time waiting for the frontend build tool to output a success or error pattern.
      See Also:

    • SERVLET_PARAMETER_DEVMODE_VITE_OPTIONS

      public static final String SERVLET_PARAMETER_DEVMODE_VITE_OPTIONS
      Configuration name for adding extra options to the vite.
      See Also:

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

    • SERVLET_PARAMETER_DEVMODE_HOSTS_ALLOWED

      public static final String SERVLET_PARAMETER_DEVMODE_HOSTS_ALLOWED
      A comma separated list of IP addresses, potentially with wildcards, which can connect to the dev tools. If not specified, only localhost connections are allowed.
      See Also:

    • SERVLET_PARAMETER_DEVMODE_REMOTE_ADDRESS_HEADER

      public static final String SERVLET_PARAMETER_DEVMODE_REMOTE_ADDRESS_HEADER
      The name of the custom HTTP header that contains the client IP address that is checked to allow access to the dev mode server. The HTTP header is supposed to contain a single address, and the HTTP request to have a single occurrence of the header. If not specified, remote address are read from the X-Forwarded-For header.
      See Also:

    • SERVLET_PARAMETER_ENABLE_PNPM

      public static final String SERVLET_PARAMETER_ENABLE_PNPM
      Configuration parameter name for enabling pnpm.
      Since:
      2.2
      See Also:

    • SERVLET_PARAMETER_ENABLE_BUN

      public static final String SERVLET_PARAMETER_ENABLE_BUN
      Configuration parameter name for enabling bun.
      See Also:

    • SERVLET_PARAMETER_DEVMODE_STATISTICS

      public static final String SERVLET_PARAMETER_DEVMODE_STATISTICS
      See Also:

    • SERVLET_PARAMETER_GLOBAL_PNPM

      public static final String SERVLET_PARAMETER_GLOBAL_PNPM
      Configuration parameter name for using globally installed pnpm or default one.
      See Also:

    • SERVLET_PARAMETER_DEVMODE_ENABLE_LIVE_RELOAD

      public static final String SERVLET_PARAMETER_DEVMODE_ENABLE_LIVE_RELOAD
      Configuration parameter name for enabling live reload.

      Note that if the dev tools are disabled (SERVLET_PARAMETER_DEVMODE_ENABLE_DEV_TOOLS is set to false), the live reload will be disabled as well.

      Since:
      See Also:

    • SERVLET_PARAMETER_DEVMODE_ENABLE_DEV_TOOLS

      public static final String SERVLET_PARAMETER_DEVMODE_ENABLE_DEV_TOOLS
      Configuration parameter name for enabling dev tools.
      Since:
      9.0
      See Also:

    • APPLICATION_PARAMETER_DEVMODE_ENABLE_SERIALIZE_SESSION

      public static final String APPLICATION_PARAMETER_DEVMODE_ENABLE_SERIALIZE_SESSION
      Configuration parameter name for enabling session serialization in development. If enabled, all the session's associated UI instances will be serialized. Otherwise, it won't be serialized.
      Since:
      See Also:

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

    • FRONTEND_EXTRA_EXTENSIONS

      public static final String FRONTEND_EXTRA_EXTENSIONS
      Configuration parameter name for adding extra file extensions for stats bundle to generate hashes for.
      See Also:

    • I18N_PROVIDER

      public static final String I18N_PROVIDER
      I18N provider property.
      See Also:

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

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

    • NODE_AUTO_UPDATE

      public static final String NODE_AUTO_UPDATE
      Configuration parameter name for requiring node executable installed in home directory.
      Since:
      See Also:

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

    • BUILD_FOLDER

      public static final String BUILD_FOLDER
      Configuration name for the build folder.
      Since:
      See Also:

    • ADDITIONAL_POSTINSTALL_PACKAGES

      public static final String ADDITIONAL_POSTINSTALL_PACKAGES
      Packages, in addition to the internally used ones, to run postinstall scripts for.
      Since:
      See Also:

    • FRONTEND_HOTDEPLOY

      public static final String FRONTEND_HOTDEPLOY
      Configuration name for enabling development using the frontend development server instead of using an application bundle.
      See Also:

    • FRONTEND_HOTDEPLOY_DEPENDENCIES

      public static final String FRONTEND_HOTDEPLOY_DEPENDENCIES
      Configuration name for adding dependencies on other projects when using the frontend development server.
      See Also:

    • CI_BUILD

      public static final String CI_BUILD
      Configuration name for enabling ci build for npm/pnpm.
      See Also:

    • SKIP_DEV_BUNDLE_REBUILD

      public static final String SKIP_DEV_BUNDLE_REBUILD
      Configuration name for disabling dev bundle rebuild.
      See Also:

    • FORCE_PRODUCTION_BUILD

      public static final String FORCE_PRODUCTION_BUILD
      Configuration name for forcing optimized production bundle build.
      See Also:

    • COMPRESS_BUNDLE

      public static final String COMPRESS_BUNDLE
      Configuration name for forcing optimized production bundle build.
      See Also:

    • COMMERCIAL_WITH_BANNER

      public static final String COMMERCIAL_WITH_BANNER
      Configuration name to enable adding a commercial banner to the application when commercial components are used without a valid license key.
      See Also:

    • CLEAN_BUILD_FRONTEND_FILES

      public static final String CLEAN_BUILD_FRONTEND_FILES
      Configuration name for cleaning or leaving frontend files in build.
      See Also:

    • LAUNCH_BROWSER_DELAY

      public static final String LAUNCH_BROWSER_DELAY
      Configuration name for how long since last browser open before we open a new tab for the application in development mode. Time is given in minutes.
      See Also:

    • APPLICATION_IDENTIFIER

      public static final String APPLICATION_IDENTIFIER
      Configuration name for setting the application identifier.
      See Also:

    • NPM_EXCLUDE_WEB_COMPONENTS

      public static final String NPM_EXCLUDE_WEB_COMPONENTS
      Configuration name for excluding npm packages for web components.
      See Also:

  • Constructor Details

    • InitParameters

      public InitParameters()