com.vaadin.flow.server.
Class Constants
- java.lang.Object
-
- com.vaadin.flow.server.Constants
-
All Implemented Interfaces:
public final class Constants extends Object implements Serializable
Constants used by the server side framework.
Not available on the client side, for that use
ApplicationConstants
.Since:
1.0
See Also:
-
-
Field Summary
Fields Modifier and Type Field and Description static String
COMPATIBILITY_RESOURCES_FRONTEND_DEFAULT
Location for the frontend resources in jar files for compatibility mode (also obsolete but supported for NPM mode).
static String
COMPILED_WEB_COMPONENTS_PATH
Configuration name for the parameter that sets the compiled web components path.
static String
CONNECT_APPLICATION_PROPERTIES_TOKEN
static String
CONNECT_GENERATED_TS_DIR_TOKEN
static String
CONNECT_JAVA_SOURCE_FOLDER_TOKEN
static String
CONNECT_OPEN_API_FILE_TOKEN
static String
DEFAULT_EXTERNAL_STATS_URL
Default location to look for the external stats.json.
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
ENABLE_PNPM_DEFAULT_STRING
Constant for whether pnpm is default or not.
static String
EXTERNAL_STATS_FILE
Property boolean for marking stats.json to be fetched from external location.
static String
EXTERNAL_STATS_FILE_TOKEN
static String
EXTERNAL_STATS_URL
Property String for external stats.json location url.
static String
EXTERNAL_STATS_URL_TOKEN
static String
FRONTEND_TOKEN
static String
GENERATED_TOKEN
static String
I18N_PROVIDER
I18N provider property.
static String
LOCAL_FRONTEND_RESOURCES_PATH
Default path for local frontend resources packaged for jar add-ons.
static String
META_INF
The path used in the vaadin servlet for handling static resources.
static String
NPM_TOKEN
static String
PACKAGE_JSON
Name of the
npm
main file.static String
POLYFILLS_DEFAULT_VALUE
static String
REQUIRE_HOME_NODE_EXECUTABLE
Configuration parameter name for requiring node executable installed in home directory.
static String
REQUIRED_ATMOSPHERE_RUNTIME_VERSION
static String
RESOURCES_FRONTEND_DEFAULT
Location for the frontend resources in jar files.
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_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_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
SERVLET_PARAMETER_DEVMODE_WEBPACK_SUCCESS_PATTERN
andSERVLET_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_INITIAL_UIDL
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_USE_V14_BOOTSTRAP
Enable it if your project is using client-side bootstrapping (CCDM).
static String
SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT
static String
STATISTIC_FLOW_BOOTSTRAPHANDLER
UsageEntry name for UsageStatistics BootstrapHandler.
static String
STATISTIC_ROUTING_CLIENT
UsageEntry name for UsageStatistics Routing Client.
static String
STATISTIC_ROUTING_HYBRID
UsageEntry name for UsageStatistics Hybrid.
static String
STATISTIC_ROUTING_SERVER
UsageEntry name for UsageStatistics Routing Server.
static String
STATISTICS_JSON_DEFAULT
Default path for the WebPack profile statistics json file.
static String
URL_PARAMETER_CLOSE_APPLICATION
A request parameter that can be given in browser to force the Vaadin application to close an existing UI and session.
static String
URL_PARAMETER_RESTART_APPLICATION
A request parameter that can be given in browser to force the Vaadin application to create a new UI and session instance, thus overriding
@PreserveOnRefresh
annotation.static String
VAADIN_BUILD
The static build resources folder.
static String
VAADIN_BUILD_FILES_PATH
The prefix used for all internal static files, relative to context root.
static String
VAADIN_CONFIGURATION
The static configuration resources folder.
static String
VAADIN_MAPPING
The path used in the vaadin servlet for handling static resources.
static String
VAADIN_PREFIX
The prefix used for System property parameters.
static String
VAADIN_SERVLET_RESOURCES
The path to meta-inf/VAADIN/ where static resources are put on the servlet.
static String
VAADIN_VERSIONS_JSON
The name of platform versions file.
-
-
-
Field Detail
-
REQUIRED_ATMOSPHERE_RUNTIME_VERSION
public static final String REQUIRED_ATMOSPHERE_RUNTIME_VERSION
See Also:
-
VAADIN_PREFIX
public static final String VAADIN_PREFIX
The prefix used for System property parameters.
See Also:
-
SERVLET_PARAMETER_PRODUCTION_MODE
public static final String SERVLET_PARAMETER_PRODUCTION_MODE
See Also:
-
NPM_TOKEN
public static final String NPM_TOKEN
See Also:
-
FRONTEND_TOKEN
public static final String FRONTEND_TOKEN
See Also:
-
GENERATED_TOKEN
public static final String GENERATED_TOKEN
See Also:
-
CONNECT_JAVA_SOURCE_FOLDER_TOKEN
public static final String CONNECT_JAVA_SOURCE_FOLDER_TOKEN
See Also:
-
CONNECT_APPLICATION_PROPERTIES_TOKEN
public static final String CONNECT_APPLICATION_PROPERTIES_TOKEN
See Also:
-
CONNECT_OPEN_API_FILE_TOKEN
public static final String CONNECT_OPEN_API_FILE_TOKEN
See Also:
-
CONNECT_GENERATED_TS_DIR_TOKEN
public static final String CONNECT_GENERATED_TS_DIR_TOKEN
See Also:
-
EXTERNAL_STATS_FILE_TOKEN
public static final String EXTERNAL_STATS_FILE_TOKEN
See Also:
-
EXTERNAL_STATS_URL_TOKEN
public static final String EXTERNAL_STATS_URL_TOKEN
See Also:
-
SERVLET_PARAMETER_USE_V14_BOOTSTRAP
public static final String SERVLET_PARAMETER_USE_V14_BOOTSTRAP
Enable it if your project is using client-side bootstrapping (CCDM).
See Also:
-
SERVLET_PARAMETER_INITIAL_UIDL
public static final String SERVLET_PARAMETER_INITIAL_UIDL
See Also:
-
SERVLET_PARAMETER_ENABLE_DEV_SERVER
public static final String SERVLET_PARAMETER_ENABLE_DEV_SERVER
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_PUSH_URL
public static final String SERVLET_PARAMETER_PUSH_URL
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:
-
POLYFILLS_DEFAULT_VALUE
public static final String POLYFILLS_DEFAULT_VALUE
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:
-
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:
-
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:
-
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
STATISTICS_JSON_DEFAULT
See Also:
-
STATISTICS_JSON_DEFAULT
public static final String STATISTICS_JSON_DEFAULT
Default path for the WebPack profile statistics json file. It can be modified by setting the system property "statistics.file.path".
See Also:
-
PACKAGE_JSON
public static final String PACKAGE_JSON
Name of the
npm
main file.See Also:
-
COMPATIBILITY_RESOURCES_FRONTEND_DEFAULT
public static final String COMPATIBILITY_RESOURCES_FRONTEND_DEFAULT
Location for the frontend resources in jar files for compatibility mode (also obsolete but supported for NPM mode).
See Also:
-
RESOURCES_FRONTEND_DEFAULT
public static final String RESOURCES_FRONTEND_DEFAULT
Location for the frontend resources in jar files.
See Also:
-
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
SERVLET_PARAMETER_DEVMODE_WEBPACK_SUCCESS_PATTERN
andSERVLET_PARAMETER_DEVMODE_WEBPACK_ERROR_PATTERN
parameters.See Also:
-
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:
-
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:
-
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:
-
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_ENABLE_PNPM
public static final String SERVLET_PARAMETER_ENABLE_PNPM
Configuration parameter name for enabling pnpm.
Since:
2.2
See Also:
-
ENABLE_PNPM_DEFAULT_STRING
public static final String ENABLE_PNPM_DEFAULT_STRING
Constant for whether pnpm is default or not. Mojos need the value as string and constant, so need to use string instead of boolean.
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:
-
META_INF
public static final String META_INF
The path used in the vaadin servlet for handling static resources.
See Also:
-
VAADIN_MAPPING
public static final String VAADIN_MAPPING
The path used in the vaadin servlet for handling static resources.
See Also:
-
VAADIN_SERVLET_RESOURCES
public static final String VAADIN_SERVLET_RESOURCES
The path to meta-inf/VAADIN/ where static resources are put on the servlet.
See Also:
-
VAADIN_BUILD
public static final String VAADIN_BUILD
The static build resources folder.
See Also:
-
VAADIN_CONFIGURATION
public static final String VAADIN_CONFIGURATION
The static configuration resources folder.
See Also:
-
VAADIN_BUILD_FILES_PATH
public static final String VAADIN_BUILD_FILES_PATH
The prefix used for all internal static files, relative to context root.
See Also:
-
LOCAL_FRONTEND_RESOURCES_PATH
public static final String LOCAL_FRONTEND_RESOURCES_PATH
Default path for local frontend resources packaged for jar add-ons.
See Also:
-
EXTERNAL_STATS_FILE
public static final String EXTERNAL_STATS_FILE
Property boolean for marking stats.json to be fetched from external location.
See Also:
-
EXTERNAL_STATS_URL
public static final String EXTERNAL_STATS_URL
Property String for external stats.json location url.
See Also:
-
DEFAULT_EXTERNAL_STATS_URL
public static final String DEFAULT_EXTERNAL_STATS_URL
Default location to look for the external stats.json.
See Also:
-
URL_PARAMETER_RESTART_APPLICATION
public static final String URL_PARAMETER_RESTART_APPLICATION
A request parameter that can be given in browser to force the Vaadin application to create a new UI and session instance, thus overriding
@PreserveOnRefresh
annotation.See Also:
-
URL_PARAMETER_CLOSE_APPLICATION
public static final String URL_PARAMETER_CLOSE_APPLICATION
A request parameter that can be given in browser to force the Vaadin application to close an existing UI and session. Unlike
URL_PARAMETER_RESTART_APPLICATION
, this will not create a new session.See Also:
-
STATISTIC_FLOW_BOOTSTRAPHANDLER
public static final String STATISTIC_FLOW_BOOTSTRAPHANDLER
UsageEntry name for UsageStatistics BootstrapHandler.
See Also:
-
STATISTIC_ROUTING_SERVER
public static final String STATISTIC_ROUTING_SERVER
UsageEntry name for UsageStatistics Routing Server.
See Also:
-
STATISTIC_ROUTING_CLIENT
public static final String STATISTIC_ROUTING_CLIENT
UsageEntry name for UsageStatistics Routing Client.
See Also:
-
STATISTIC_ROUTING_HYBRID
public static final String STATISTIC_ROUTING_HYBRID
UsageEntry name for UsageStatistics Hybrid.
See Also:
-
VAADIN_VERSIONS_JSON
public static final String VAADIN_VERSIONS_JSON
The name of platform versions file.
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.
Since:
See Also:
-
-