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.annotations.
Annotation Type VaadinServletConfiguration
-
@Retention(RUNTIME) @Target(TYPE) @Inherited public @interface VaadinServletConfigurationAnnotation for configuring subclasses of
VaadinServlet. For aVaadinServletclass that has this annotation, the defined values are read during initialization and will be available usingDeploymentConfiguration.getApplicationOrSystemProperty(String, String)as well as from specific methods inDeploymentConfiguration. Init params defined inweb.xmlor the@WebServletannotation take precedence over values defined in this annotation.Since:
7.1
Author:
Vaadin Ltd
-
-
Required Element Summary
Required Elements Modifier and Type Required Element Description booleanproductionModeWhether Vaadin is in production mode.
Class<? extends UI>uiGets the default UI class to use for the servlet.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description booleancloseIdleSessionsWhether a session should be closed when all its open UIs have been idle for longer than its configured maximum inactivity time.
intheartbeatIntervalThe number of seconds between heartbeat requests of a UI, or a non-positive number if heartbeat is disabled.
DeploymentConfiguration.LegacyProperyToStringModelegacyPropertyToStringModeDeprecated.
as of 7.1, should only be used to ease migrationintresourceCacheTimeThe time resources can be cached in the browser, in seconds.
StringwidgetsetThe default widgetset to use for the servlet.
-
-
-
Element Detail
-
productionMode
@InitParameterName("productionMode") boolean productionModeWhether Vaadin is in production mode.
Returns:
true if in production mode, false otherwise.
See Also:
-
-
-
ui
@InitParameterName("UI") Class<? extends UI> uiGets the default UI class to use for the servlet.
Returns:
the default UI class
-
-
-
resourceCacheTime
@InitParameterName("resourceCacheTime") int resourceCacheTimeThe time resources can be cached in the browser, in seconds. The default value is 3600 seconds, i.e. one hour.
Returns:
the resource cache time
See Also:
Default:
3600
-
-
-
heartbeatInterval
@InitParameterName("heartbeatInterval") int heartbeatIntervalThe 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
@InitParameterName("closeIdleSessions") boolean closeIdleSessionsWhether 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
-
-
-
widgetset
@InitParameterName("widgetset") String widgetsetThe default widgetset to use for the servlet. The default value is
"", which will causecom.vaadin.DefaultWidgetSetto be used unless overridden by an init parameter or unless an automatically generatedAppWidgetsetis used.Returns:
the default widgetset name
Default:
""
-
-
-
legacyPropertyToStringMode
@Deprecated @InitParameterName("legacyPropertyToString") DeploymentConfiguration.LegacyProperyToStringMode legacyPropertyToStringModeDeprecated.as of 7.1, should only be used to ease migrationThe legacy Property.toString() mode used. The default value is
DeploymentConfiguration.LegacyProperyToStringMode.DISABLEDReturns:
The Property.toString() mode in use.
Default:
com.vaadin.server.DeploymentConfiguration.LegacyProperyToStringMode.DISABLED
-
-