Package com.vaadin.flow.shared
Class ApplicationConstants
- java.lang.Object
-
- com.vaadin.flow.shared.ApplicationConstants
-
- All Implemented Interfaces:
Serializable
public class ApplicationConstants extends Object implements Serializable
A utility class providing static constants. Mostly for internal use.Also available for the client side part of the framework.
- Since:
- 1.0
- Author:
- Vaadin Ltd
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static StringAPP_WC_MODEWhether the application is run in as a exported Web Component.static StringBASE_PROTOCOL_PREFIXProtocol used for referencing resources relative the base URI of the loaded page.static StringCLIENT_ENGINE_PATHPath to the Vaadin client engine folder, relative to the context root.static StringCLIENT_ROUTINGWhether the application is running vaadin-router in client side.static StringCLIENT_TO_SERVER_IDThe name of the parameter used to transmit the id of the client to server messages.static StringCONTENT_TYPE_TEXT_HTML_UTF_8Content type to use for text/html responses (should always be UTF-8).static StringCONTENT_TYPE_TEXT_JAVASCRIPT_UTF_8Content type to use for text/javascript responses (should always be UTF-8).static StringCONTEXT_PROTOCOL_PREFIXProtocol used for referencing the application context path.static StringCONTEXT_ROOT_URLConfiguration parameter giving the (in some cases relative) URL to the web application context root.static StringCSRF_TOKENThe name of the parameter used to transmit the CSRF token.static StringCSRF_TOKEN_DEFAULT_VALUEDefault value to use in case the security protection is disabled.static StringDEBUG_WINDOW_CONNECTIONWeb socket parameter which identifies connection as live reload connection.static StringDEV_TOOLS_ENABLEDBoolean client configuration parameter enabling the development tools.static StringFRONTEND_URL_ES6Configuration parameter for the build URL of ES6 web components.static StringPUSH_ID_PARAMETERName of the parameter used to transmit the push connection identifier.static StringREQUEST_LOCATION_PARAMETERParameter for the initial router location when JavaScript bootstrapping.static StringREQUEST_QUERY_PARAMETERParameter for the initial query string when JavaScript bootstrapping.static StringREQUEST_TYPE_HEARTBEATRequest type parameter value indicating a heartbeat request.static StringREQUEST_TYPE_INITRequest type parameter value indicating an init request.static StringREQUEST_TYPE_PARAMETERGet parameter used in framework requests to identify the request type.static StringREQUEST_TYPE_PUSHRequest type parameter value indicating a push request.static StringREQUEST_TYPE_UIDLRequest type parameter value indicating a UIDL request.static StringREQUEST_TYPE_WEBCOMPONENT_RESYNCRequest type parameter value indicating a WebComponent resynchronization request.static StringRESYNCHRONIZE_IDThe name of the parameter used for re-synchronizing.static StringROUTER_LINK_ATTRIBUTEAttribute name for marking internal router link anchors.static StringRPC_INVOCATIONSThe name of the parameter used to transmit RPC invocations.static StringSERVER_SYNC_IDThe name of the parameter used to transmit the sync id.static StringSERVICE_URLThe URL which should be used to connect server-side VaadinService.static StringUI_IDThe name of the parameter used to transmit the id of UI used in given request.static StringUI_ID_PARAMETERName of the parameter used to transmit UI ids back and forth.static StringUIDL_PUSH_IDThe identifier used for Push messages.static StringUIDL_SECURITY_TOKEN_IDThe identifier used for the CSRF token.static StringVAADIN_PUSH_DEBUG_JSThe name of the debug version of the javascript containing push support.static StringVAADIN_PUSH_JSThe name of the javascript containing push support.static StringVAADIN_STATIC_FILES_PATHThe prefix used for all internal static files, relative to context root.
-
Constructor Summary
Constructors Constructor Description ApplicationConstants()
-
-
-
Field Detail
-
CONTEXT_PROTOCOL_PREFIX
public static final String CONTEXT_PROTOCOL_PREFIX
Protocol used for referencing the application context path.- See Also:
- Constant Field Values
-
BASE_PROTOCOL_PREFIX
public static final String BASE_PROTOCOL_PREFIX
Protocol used for referencing resources relative the base URI of the loaded page.- See Also:
- Constant Field Values
-
UIDL_SECURITY_TOKEN_ID
public static final String UIDL_SECURITY_TOKEN_ID
The identifier used for the CSRF token.- See Also:
- Constant Field Values
-
UIDL_PUSH_ID
public static final String UIDL_PUSH_ID
The identifier used for Push messages.- See Also:
- Constant Field Values
-
SERVICE_URL
public static final String SERVICE_URL
The URL which should be used to connect server-side VaadinService.- See Also:
- Constant Field Values
-
APP_WC_MODE
public static final String APP_WC_MODE
Whether the application is run in as a exported Web Component.- See Also:
- Constant Field Values
-
CLIENT_ROUTING
public static final String CLIENT_ROUTING
Whether the application is running vaadin-router in client side.- See Also:
- Constant Field Values
-
CONTEXT_ROOT_URL
public static final String CONTEXT_ROOT_URL
Configuration parameter giving the (in some cases relative) URL to the web application context root.- See Also:
- Constant Field Values
-
VAADIN_STATIC_FILES_PATH
public static final String VAADIN_STATIC_FILES_PATH
The prefix used for all internal static files, relative to context root.- See Also:
- Constant Field Values
-
VAADIN_PUSH_JS
public static final String VAADIN_PUSH_JS
The name of the javascript containing push support.- See Also:
- Constant Field Values
-
VAADIN_PUSH_DEBUG_JS
public static final String VAADIN_PUSH_DEBUG_JS
The name of the debug version of the javascript containing push support.- See Also:
- Constant Field Values
-
PUSH_ID_PARAMETER
public static final String PUSH_ID_PARAMETER
Name of the parameter used to transmit the push connection identifier.- See Also:
- Constant Field Values
-
RPC_INVOCATIONS
public static final String RPC_INVOCATIONS
The name of the parameter used to transmit RPC invocations.- See Also:
- Constant Field Values
-
CSRF_TOKEN
public static final String CSRF_TOKEN
The name of the parameter used to transmit the CSRF token.- See Also:
- Constant Field Values
-
SERVER_SYNC_ID
public static final String SERVER_SYNC_ID
The name of the parameter used to transmit the sync id. The value can be set to -1 e.g. when testing with pre-recorded requests to make the framework ignore the sync id.
-
CLIENT_TO_SERVER_ID
public static final String CLIENT_TO_SERVER_ID
The name of the parameter used to transmit the id of the client to server messages.- See Also:
- Constant Field Values
-
UI_ID
public static final String UI_ID
The name of the parameter used to transmit the id of UI used in given request.- See Also:
- Constant Field Values
-
CSRF_TOKEN_DEFAULT_VALUE
public static final String CSRF_TOKEN_DEFAULT_VALUE
Default value to use in case the security protection is disabled.- See Also:
- Constant Field Values
-
RESYNCHRONIZE_ID
public static final String RESYNCHRONIZE_ID
The name of the parameter used for re-synchronizing.- See Also:
- Constant Field Values
-
CONTENT_TYPE_TEXT_HTML_UTF_8
public static final String CONTENT_TYPE_TEXT_HTML_UTF_8
Content type to use for text/html responses (should always be UTF-8).- See Also:
- Constant Field Values
-
CONTENT_TYPE_TEXT_JAVASCRIPT_UTF_8
public static final String CONTENT_TYPE_TEXT_JAVASCRIPT_UTF_8
Content type to use for text/javascript responses (should always be UTF-8).- See Also:
- Constant Field Values
-
UI_ID_PARAMETER
public static final String UI_ID_PARAMETER
Name of the parameter used to transmit UI ids back and forth.- See Also:
- Constant Field Values
-
CLIENT_ENGINE_PATH
public static final String CLIENT_ENGINE_PATH
Path to the Vaadin client engine folder, relative to the context root.- See Also:
- Constant Field Values
-
REQUEST_LOCATION_PARAMETER
public static final String REQUEST_LOCATION_PARAMETER
Parameter for the initial router location when JavaScript bootstrapping. It is optional whenREQUEST_TYPE_PARAMETERhas theREQUEST_TYPE_INITvalue- See Also:
- Constant Field Values
-
REQUEST_QUERY_PARAMETER
public static final String REQUEST_QUERY_PARAMETER
Parameter for the initial query string when JavaScript bootstrapping.- See Also:
- Constant Field Values
-
REQUEST_TYPE_PARAMETER
public static final String REQUEST_TYPE_PARAMETER
Get parameter used in framework requests to identify the request type.- See Also:
- Constant Field Values
-
REQUEST_TYPE_INIT
public static final String REQUEST_TYPE_INIT
Request type parameter value indicating an init request.- See Also:
- Constant Field Values
-
REQUEST_TYPE_UIDL
public static final String REQUEST_TYPE_UIDL
Request type parameter value indicating a UIDL request.- See Also:
- Constant Field Values
-
REQUEST_TYPE_HEARTBEAT
public static final String REQUEST_TYPE_HEARTBEAT
Request type parameter value indicating a heartbeat request.- See Also:
- Constant Field Values
-
REQUEST_TYPE_PUSH
public static final String REQUEST_TYPE_PUSH
Request type parameter value indicating a push request.- See Also:
- Constant Field Values
-
REQUEST_TYPE_WEBCOMPONENT_RESYNC
public static final String REQUEST_TYPE_WEBCOMPONENT_RESYNC
Request type parameter value indicating a WebComponent resynchronization request.- See Also:
- Constant Field Values
-
ROUTER_LINK_ATTRIBUTE
public static final String ROUTER_LINK_ATTRIBUTE
Attribute name for marking internal router link anchors.- See Also:
- Constant Field Values
-
FRONTEND_URL_ES6
public static final String FRONTEND_URL_ES6
Configuration parameter for the build URL of ES6 web components.- See Also:
- Constant Field Values
-
DEBUG_WINDOW_CONNECTION
public static final String DEBUG_WINDOW_CONNECTION
Web socket parameter which identifies connection as live reload connection.- See Also:
- Constant Field Values
-
DEV_TOOLS_ENABLED
public static final String DEV_TOOLS_ENABLED
Boolean client configuration parameter enabling the development tools.- See Also:
- Constant Field Values
-
-