Package com.vaadin.annotations

Annotation Type VaadinServletConfiguration

@Retention(RUNTIME)
@Target(TYPE)
@Inherited
public @interface VaadinServletConfiguration

Annotation for configuring subclasses of VaadinServlet. For a VaadinServlet class that has this annotation, the defined values are read during initialization and will be available using DeploymentConfiguration.getApplicationOrSystemProperty(String, String) as well as from specific methods in DeploymentConfiguration. Init params defined in web.xml or the @WebServlet annotation 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
boolean	productionMode	Whether Vaadin is in production mode.
Class<? extends UI>	ui	Gets the default UI class to use for the servlet.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	closeIdleSessions	Whether a session should be closed when all its open UIs have been idle for longer than its configured maximum inactivity time.
int	heartbeatInterval	The number of seconds between heartbeat requests of a UI, or a non-positive number if heartbeat is disabled.
int	resourceCacheTime	The time resources can be cached in the browser, in seconds.
int	uiPriority	Gets the priority of the default UI class for the servlet.
String	widgetset	The default widgetset to use for the servlet.

Element Detail

productionMode

@InitParameterName("productionMode")
boolean productionMode

Whether Vaadin is in production mode.

Returns:

true if in production mode, false otherwise.

See Also:

DeploymentConfiguration.isProductionMode()

ui

@InitParameterName("UI")
Class<? extends UI> ui

Gets the default UI class to use for the servlet.

Returns:

the default UI class

uiPriority

@InitParameterName("UIPriority")
int uiPriority

Gets the priority of the default UI class for the servlet. When faced with multiple UI providers, higher priority providers are served first.

Returns:

the priority of the default UI class (defaults to 0)

Since:

8.21

See Also:

DeploymentConfiguration.getUIProviderPriority()

Default:

0

resourceCacheTime

@InitParameterName("resourceCacheTime")
int resourceCacheTime

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

DeploymentConfiguration.getResourceCacheTime()

Default:

3600

heartbeatInterval

@InitParameterName("heartbeatInterval")
int heartbeatInterval

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:

DeploymentConfiguration.getHeartbeatInterval()

Default:

300

closeIdleSessions

@InitParameterName("closeIdleSessions")
boolean closeIdleSessions

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:

DeploymentConfiguration.isCloseIdleSessions()

Default:

false

widgetset

@InitParameterName("widgetset")
String widgetset

The default widgetset to use for the servlet. The default value is "", which will cause com.vaadin.DefaultWidgetSet to be used unless overridden by an init parameter or unless an automatically generated AppWidgetset is used.

Returns:

the default widgetset name

Default:

""