We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.server.
Annotation Type VaadinServletConfiguration
-
Deprecated.
Leftover from Vaadin Framework 8 where the developer typically defines their own servlet class. Starting from Flow 1.0, a servlet is automatically registered and this annotation serves very little purpose.
@Retention(value=RUNTIME) @Target(value=TYPE) @Deprecated public @interface VaadinServletConfigurationConfigures subclasses of
VaadinServlet. For aVaadinServletclass that has this annotation, the defined values are read during initialization and will be available usingDeploymentConfiguration.getApplicationOrSystemProperty(String, Object, Function)as well as from specific methods inDeploymentConfiguration. Init params defined inweb.xmlor the@WebServletannotation take precedence over values defined in this annotation.Since:
1.0
Author:
Vaadin Ltd
-
-
Required Element Summary
Required Elements Modifier and Type Required Element and Description booleanproductionModeDeprecated.
Whether Vaadin is in production mode.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description booleancloseIdleSessionsDeprecated.
Whether a session should be closed when all its open UIs have been idle for longer than its configured maximum inactivity time.
booleandisableAutomaticServletRegistrationDeprecated.
Whether the framework should register automatic servlets for the application or not.
intheartbeatIntervalDeprecated.
The number of seconds between heartbeat requests of a UI, or a non-positive number if heartbeat is disabled.
Class<? extends UI>uiDeprecated.
Gets the UI class to use for the servlet.
-
-
-
Element Detail
-
productionMode
@VaadinServletConfiguration.InitParameterName(value="productionMode") public abstract boolean productionModeDeprecated.
Whether Vaadin is in production mode.
Returns:
true if in production mode, false otherwise.
See Also:
-
-
-
ui
@VaadinServletConfiguration.InitParameterName(value="UI") public abstract Class<? extends UI> uiDeprecated.
Gets the UI class to use for the servlet.
Returns:
the UI class
Default:
com.vaadin.flow.component.UI.class
-
-
-
heartbeatInterval
@VaadinServletConfiguration.InitParameterName(value="heartbeatInterval") public abstract int heartbeatIntervalDeprecated.
The number of seconds between heartbeat requests of a UI, or a non-positive number if heartbeat is disabled. The default value is 300 seconds, i.e. 5 minutes.
Returns:
the time between heartbeats
See Also:
Default:
300
-
-
-
closeIdleSessions
@VaadinServletConfiguration.InitParameterName(value="closeIdleSessions") public abstract boolean closeIdleSessionsDeprecated.
Whether a session should be closed when all its open UIs have been idle for longer than its configured maximum inactivity time. The default value is
false.Returns:
true if UIs and sessions receiving only heartbeat requests are eventually closed; false if heartbeat requests extend UI and session lifetime indefinitely
See Also:
Default:
false
-
-
-
disableAutomaticServletRegistration
@VaadinServletConfiguration.InitParameterName(value="disable.automatic.servlet.registration") public abstract boolean disableAutomaticServletRegistrationDeprecated.
Whether the framework should register automatic servlets for the application or not. The default value is
false.Returns:
true if no automatic servlet registration should be done
See Also:
DeploymentConfiguration.disableAutomaticServletRegistration()Default:
false
-
-