Package com.vaadin.flow.server

Class DefaultDeploymentConfiguration

java.lang.Object

com.vaadin.flow.server.AbstractPropertyConfiguration

com.vaadin.flow.server.AbstractDeploymentConfiguration

com.vaadin.flow.server.PropertyDeploymentConfiguration

com.vaadin.flow.server.DefaultDeploymentConfiguration

All Implemented Interfaces:

DeploymentConfiguration, AbstractConfiguration, Serializable

public class DefaultDeploymentConfiguration
extends PropertyDeploymentConfiguration

The default implementation of DeploymentConfiguration based on a base class for resolving system properties and a set of init parameters.

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_CLOSE_IDLE_SESSIONS	Default value for isCloseIdleSessions() = false .
static final int	DEFAULT_HEARTBEAT_INTERVAL	Default value for getHeartbeatInterval() = 300 .
static final int	DEFAULT_MAX_MESSAGE_SUSPEND_TIMEOUT	Default value for getMaxMessageSuspendTimeout() ()} = 5000 .
static final long	DEFAULT_MAX_REQUEST_BODY_SIZE	Default value for getMaxRequestBodySize() = 10485760L characters (10 MB).
static final boolean	DEFAULT_SEND_URLS_AS_PARAMETERS
static final boolean	DEFAULT_SYNC_ID_CHECK	Default value for isSyncIdCheckEnabled() = true .
static final int	DEFAULT_WEB_COMPONENT_DISCONNECT	Default value for getWebComponentDisconnect() = 300.
static final String	NOT_PRODUCTION_MODE_INFO
static final String	WARNING_HEARTBEAT_INTERVAL_NOT_NUMERIC
static final String	WARNING_PUSH_MODE_NOT_RECOGNIZED
static final String	WARNING_SESSION_LOCK_CHECK_STRATEGY_NOT_RECOGNIZED
static final String	WARNING_XSRF_PROTECTION_DISABLED

Constructor Summary

Constructors

Constructor	Description
DefaultDeploymentConfiguration(ApplicationConfiguration parentConfig, Class<?> systemPropertyBaseClass, Properties initParameters)	Create a new deployment configuration instance.

Method Summary

Modifier and Type	Method	Description
int	getHeartbeatInterval()	Returns the number of seconds between heartbeat requests of a UI, or a non-positive number if heartbeat is disabled.
int	getMaxMessageSuspendTimeout()	In certain cases, such as when combining XmlHttpRequests and push over low bandwidth connections, messages may be received out of order by the client.
long	getMaxRequestBodySize()	Returns the maximum size, in characters, that Flow reads from a client-to-server UIDL/RPC or push request body before rejecting the request with HTTP 413 (Request Entity Too Large).
Mode	getMode()	Gets the mode the application is running in.
PushMode	getPushMode()	Returns the mode of bidirectional ("push") client-server communication that should be used.
String	getPushServletMapping()	Returns the servlet mapping that bidirectional ("push") client-server communication should use.
SessionLockCheckStrategy	getSessionLockCheckStrategy()	Returns the strategy for Vaadin session lock checking in production mode.
int	getWebComponentDisconnect()	Returns the number of seconds that a WebComponent will wait for a reconnect before removing the server-side component from memory.
boolean	isCloseIdleSessions()	Returns whether a Vaadin session should be closed when all its open UIs have been idle for longer than its configured maximum inactivity time.
boolean	isProductionMode()	Returns whether Vaadin is in production mode.
boolean	isRequestTiming()	Returns whether the server provides timing info to the client.
boolean	isSendUrlsAsParameters()	Returns whether the sending of URL's as GET and POST parameters in requests with content-type application/x-www-form-urlencoded is enabled or not.
boolean	isSyncIdCheckEnabled()	Returns whether sync id checking is enabled.
boolean	isXsrfProtectionEnabled()	Returns whether cross-site request forgery protection is enabled.

Methods inherited from class com.vaadin.flow.server.PropertyDeploymentConfiguration

getApplicationProperty, getBuildFolder, getFrontendFolder, getInitParameters, getJavaResourceFolder, getJavaSourceFolder, getOutputResourceFolder, getParentConfiguration, getSystemProperty, isBrowserless, isBunEnabled, isDevModeLiveReloadEnabled, isDevToolsEnabled, isGlobalPnpm, isOwnProperty, isPnpmEnabled, isUsageStatisticsEnabled, reuseDevServer

Methods inherited from class com.vaadin.flow.server.AbstractDeploymentConfiguration

getClassLoaderName, getUIClassName, getUrlSafeSchemes

Methods inherited from class com.vaadin.flow.server.AbstractPropertyConfiguration

getApplicationOrSystemProperty, getApplicationProperty, getBooleanProperty, getProperties, getStringProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.server.AbstractConfiguration

getProjectFolder, getStringProperty

Methods inherited from interface com.vaadin.flow.function.DeploymentConfiguration

getApplicationName, getApplicationOrSystemProperty, getBooleanProperty, getCompiledWebComponentsPath, getExternalStatsUrl, getPolyfills, isBrotli, isEagerServerLoad, isReactEnabled, isStatsExternal

Field Details

NOT_PRODUCTION_MODE_INFO

public static final String NOT_PRODUCTION_MODE_INFO

See Also:

• Constant Field Values

WARNING_XSRF_PROTECTION_DISABLED

public static final String WARNING_XSRF_PROTECTION_DISABLED

See Also:

• Constant Field Values

WARNING_HEARTBEAT_INTERVAL_NOT_NUMERIC

public static final String WARNING_HEARTBEAT_INTERVAL_NOT_NUMERIC

See Also:

• Constant Field Values

WARNING_PUSH_MODE_NOT_RECOGNIZED

public static final String WARNING_PUSH_MODE_NOT_RECOGNIZED

See Also:

• Constant Field Values

WARNING_SESSION_LOCK_CHECK_STRATEGY_NOT_RECOGNIZED

public static final String WARNING_SESSION_LOCK_CHECK_STRATEGY_NOT_RECOGNIZED

DEFAULT_HEARTBEAT_INTERVAL

public static final int DEFAULT_HEARTBEAT_INTERVAL

Default value for getHeartbeatInterval() = 300 .

See Also:

• Constant Field Values

DEFAULT_MAX_MESSAGE_SUSPEND_TIMEOUT

public static final int DEFAULT_MAX_MESSAGE_SUSPEND_TIMEOUT

Default value for getMaxMessageSuspendTimeout() ()} = 5000 .

See Also:

• Constant Field Values

DEFAULT_MAX_REQUEST_BODY_SIZE

public static final long DEFAULT_MAX_REQUEST_BODY_SIZE

Default value for getMaxRequestBodySize() = 10485760L characters (10 MB).

See Also:

• Constant Field Values

DEFAULT_WEB_COMPONENT_DISCONNECT

public static final int DEFAULT_WEB_COMPONENT_DISCONNECT

Default value for getWebComponentDisconnect() = 300.

See Also:

• Constant Field Values

DEFAULT_CLOSE_IDLE_SESSIONS

public static final boolean DEFAULT_CLOSE_IDLE_SESSIONS

Default value for isCloseIdleSessions() = false .

See Also:

• Constant Field Values

DEFAULT_SYNC_ID_CHECK

public static final boolean DEFAULT_SYNC_ID_CHECK

Default value for isSyncIdCheckEnabled() = true .

See Also:

• Constant Field Values

DEFAULT_SEND_URLS_AS_PARAMETERS

public static final boolean DEFAULT_SEND_URLS_AS_PARAMETERS

See Also:

• Constant Field Values

Constructor Details

DefaultDeploymentConfiguration

public DefaultDeploymentConfiguration(ApplicationConfiguration parentConfig,
 Class<?> systemPropertyBaseClass,
 Properties initParameters)

Create a new deployment configuration instance.

Parameters:

parentConfig - a parent application configuration

systemPropertyBaseClass - the class that should be used as a basis when reading system properties

initParameters - the init parameters that should make up the foundation for this configuration

Method Details

isProductionMode

public boolean isProductionMode()

Returns whether Vaadin is in production mode.

The default is false.

Specified by:

isProductionMode in interface AbstractConfiguration

Overrides:

isProductionMode in class PropertyDeploymentConfiguration

Returns:

true if in production mode, false otherwise.

isRequestTiming

public boolean isRequestTiming()

Returns whether the server provides timing info to the client.

The default is true when not in production and false when in production mode.

Specified by:

isRequestTiming in interface DeploymentConfiguration

Overrides:

isRequestTiming in class PropertyDeploymentConfiguration

Returns:

true if timing info is provided, false otherwise.

isXsrfProtectionEnabled

public boolean isXsrfProtectionEnabled()

Returns whether cross-site request forgery protection is enabled.

The default is true.

Specified by:

isXsrfProtectionEnabled in interface AbstractConfiguration

Overrides:

isXsrfProtectionEnabled in class PropertyDeploymentConfiguration

Returns:

true if XSRF protection is enabled, false otherwise.

getHeartbeatInterval

public int getHeartbeatInterval()

Returns the number of seconds between heartbeat requests of a UI, or a non-positive number if heartbeat is disabled.

The default interval is 300 seconds (5 minutes).

Specified by:

getHeartbeatInterval in interface DeploymentConfiguration

Overrides:

getHeartbeatInterval in class PropertyDeploymentConfiguration

Returns:

The time between heartbeats.

getMaxRequestBodySize

public long getMaxRequestBodySize()

Returns the maximum size, in characters, that Flow reads from a client-to-server UIDL/RPC or push request body before rejecting the request with HTTP 413 (Request Entity Too Large).

The limit does not apply to file uploads, which are streamed in chunks and have their own separate size limits.

The default is 10 MB.

Specified by:

getMaxRequestBodySize in interface DeploymentConfiguration

Overrides:

getMaxRequestBodySize in class PropertyDeploymentConfiguration

Returns:

the maximum request body size in characters, or a negative number if the limit is disabled

getMaxMessageSuspendTimeout

public int getMaxMessageSuspendTimeout()

In certain cases, such as when combining XmlHttpRequests and push over low bandwidth connections, messages may be received out of order by the client. This property specifies the maximum time (in milliseconds) that the client will then wait for the predecessors of a received out-order message, before considering them missing and requesting a full resynchronization of the application state from the server.

The default max message suspension time is 5000 milliseconds.

Specified by:

getMaxMessageSuspendTimeout in interface DeploymentConfiguration

Overrides:

getMaxMessageSuspendTimeout in class PropertyDeploymentConfiguration

Returns:

The maximum message suspension timeout

getWebComponentDisconnect

public int getWebComponentDisconnect()

Description copied from interface: DeploymentConfiguration

Returns the number of seconds that a WebComponent will wait for a reconnect before removing the server-side component from memory.

Specified by:

getWebComponentDisconnect in interface DeploymentConfiguration

Overrides:

getWebComponentDisconnect in class PropertyDeploymentConfiguration

Returns:

time to wait after a disconnect has happened

isCloseIdleSessions

public boolean isCloseIdleSessions()

Returns whether a Vaadin session should be closed when all its open UIs have been idle for longer than its configured maximum inactivity time.

A UI is idle if it is open on the client side but has no activity other than heartbeat requests. If isCloseIdleSessions() == false, heartbeat requests cause the session to stay open for as long as there are open UIs on the client side. If it is true, the session is eventually closed if the open UIs do not have any user interaction.

The default value is false.

Specified by:

isCloseIdleSessions in interface DeploymentConfiguration

Overrides:

isCloseIdleSessions in class PropertyDeploymentConfiguration

Returns:

True if UIs and Vaadin sessions receiving only heartbeat requests are eventually closed; false if heartbeat requests extend UI and session lifetime indefinitely.

See Also:

• WrappedSession.getMaxInactiveInterval()

isSyncIdCheckEnabled

public boolean isSyncIdCheckEnabled()

Returns whether sync id checking is enabled. The sync id is used to gracefully handle situations when the client sends a message to a connector that has recently been removed on the server.

The default value is true.

Specified by:

isSyncIdCheckEnabled in interface DeploymentConfiguration

Overrides:

isSyncIdCheckEnabled in class PropertyDeploymentConfiguration

Returns:

true if sync id checking is enabled; false otherwise

isSendUrlsAsParameters

public boolean isSendUrlsAsParameters()

Returns whether the sending of URL's as GET and POST parameters in requests with content-type application/x-www-form-urlencoded is enabled or not.

The default value is true.

Specified by:

isSendUrlsAsParameters in interface DeploymentConfiguration

Overrides:

isSendUrlsAsParameters in class PropertyDeploymentConfiguration

Returns:

false if set to false or true otherwise

getPushMode

public PushMode getPushMode()

Returns the mode of bidirectional ("push") client-server communication that should be used.

The default mode is PushMode.DISABLED.

Specified by:

getPushMode in interface DeploymentConfiguration

Overrides:

getPushMode in class PropertyDeploymentConfiguration

Returns:

The push mode in use.

getPushServletMapping

public String getPushServletMapping()

Returns the servlet mapping that bidirectional ("push") client-server communication should use.

The default mode is "" which uses the service mapping.

Returns:

The push servlet mapping to use

getSessionLockCheckStrategy

public SessionLockCheckStrategy getSessionLockCheckStrategy()

Description copied from interface: DeploymentConfiguration

Returns the strategy for Vaadin session lock checking in production mode. Ignored in development mode. By default, it returns SessionLockCheckStrategy.ASSERT.

Specified by:

getSessionLockCheckStrategy in interface DeploymentConfiguration

Overrides:

getSessionLockCheckStrategy in class PropertyDeploymentConfiguration

Returns:

the lock checking strategy, never null.

getMode

public Mode getMode()

Description copied from interface: AbstractConfiguration

Gets the mode the application is running in.

Returns:

custom production bundle, pre-compiled production bundle, development using livereload or development using bundle