com.vaadin.flow.server.

Class 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 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_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:

        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_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_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

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

      • 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

    • Constructor Detail

      • InitParameters

        public InitParameters()