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:

  • Field Details

    • CONTEXT_PROTOCOL_PREFIX

      public static final String CONTEXT_PROTOCOL_PREFIX
      Protocol used for referencing the application context path.
      See Also:

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

    • UIDL_SECURITY_TOKEN_ID

      public static final String UIDL_SECURITY_TOKEN_ID
      The identifier used for the CSRF token.
      See Also:

    • UIDL_PUSH_ID

      public static final String UIDL_PUSH_ID
      The identifier used for Push messages.
      See Also:

    • SERVICE_URL

      public static final String SERVICE_URL
      The URL which should be used to connect server-side VaadinService.
      See Also:

    • APP_WC_MODE

      public static final String APP_WC_MODE
      Whether the application is run in as a exported Web Component.
      See Also:

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

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

    • VAADIN_PUSH_JS

      public static final String VAADIN_PUSH_JS
      The name of the javascript containing push support.
      See Also:

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

    • PUSH_ID_PARAMETER

      public static final String PUSH_ID_PARAMETER
      Name of the parameter used to transmit the push connection identifier.
      See Also:

    • RPC_INVOCATIONS

      public static final String RPC_INVOCATIONS
      The name of the parameter used to transmit RPC invocations.
      See Also:

    • CSRF_TOKEN

      public static final String CSRF_TOKEN
      The name of the parameter used to transmit the CSRF token.
      See Also:

    • 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.
      See Also:

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

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

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

    • RESYNCHRONIZE_ID

      public static final String RESYNCHRONIZE_ID
      The name of the parameter used for re-synchronizing.
      See Also:

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

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

    • UI_ID_PARAMETER

      public static final String UI_ID_PARAMETER
      Name of the parameter used to transmit UI ids back and forth.
      See Also:

    • CLIENT_ENGINE_PATH

      public static final String CLIENT_ENGINE_PATH
      Path to the Vaadin client engine folder, relative to the context root.
      See Also:

    • REQUEST_LOCATION_PARAMETER

      public static final String REQUEST_LOCATION_PARAMETER
      Parameter for the initial router location when JavaScript bootstrapping. It is optional when REQUEST_TYPE_PARAMETER has the REQUEST_TYPE_INIT value
      See Also:

    • REQUEST_QUERY_PARAMETER

      public static final String REQUEST_QUERY_PARAMETER
      Parameter for the initial query string when JavaScript bootstrapping.
      See Also:

    • REQUEST_TYPE_PARAMETER

      public static final String REQUEST_TYPE_PARAMETER
      Get parameter used in framework requests to identify the request type.
      See Also:

    • REQUEST_TYPE_INIT

      public static final String REQUEST_TYPE_INIT
      Request type parameter value indicating an init request.
      See Also:

    • REQUEST_TYPE_UIDL

      public static final String REQUEST_TYPE_UIDL
      Request type parameter value indicating a UIDL request.
      See Also:

    • REQUEST_TYPE_HEARTBEAT

      public static final String REQUEST_TYPE_HEARTBEAT
      Request type parameter value indicating a heartbeat request.
      See Also:

    • REQUEST_TYPE_PUSH

      public static final String REQUEST_TYPE_PUSH
      Request type parameter value indicating a push request.
      See Also:

    • REQUEST_TYPE_WEBCOMPONENT_RESYNC

      public static final String REQUEST_TYPE_WEBCOMPONENT_RESYNC
      Request type parameter value indicating a WebComponent resynchronization request.
      See Also:

    • FRONTEND_URL_ES6

      public static final String FRONTEND_URL_ES6
      Configuration parameter for the build URL of ES6 web components.
      See Also:

    • DEBUG_WINDOW_CONNECTION

      public static final String DEBUG_WINDOW_CONNECTION
      Web socket parameter which identifies connection as live reload connection.
      See Also:

    • DEV_TOOLS_ENABLED

      public static final String DEV_TOOLS_ENABLED
      Boolean client configuration parameter enabling the development tools.
      See Also:

    • UNLOAD_BEACON

      public static final String UNLOAD_BEACON
      The name of the parameter used for notifying the server that user closed the tab/window or navigated away.
      See Also:

  • Constructor Details

    • ApplicationConstants

      public ApplicationConstants()