com.vaadin.flow.server

Class DefaultDeploymentConfiguration

java.lang.Object

com.vaadin.flow.server.AbstractDeploymentConfiguration

com.vaadin.flow.server.PropertyDeploymentConfiguration

com.vaadin.flow.server.DefaultDeploymentConfiguration

All Implemented Interfaces:

DeploymentConfiguration, 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 and Description
static boolean	DEFAULT_CLOSE_IDLE_SESSIONS Default value for isCloseIdleSessions() = false .
static int	DEFAULT_HEARTBEAT_INTERVAL Default value for getHeartbeatInterval() = 300 .
static int	DEFAULT_MAX_MESSAGE_SUSPEND_TIMEOUT Default value for getMaxMessageSuspendTimeout() ()} = 5000 .
static boolean	DEFAULT_SEND_URLS_AS_PARAMETERS
static boolean	DEFAULT_SYNC_ID_CHECK Default value for isSyncIdCheckEnabled() = true .
static int	DEFAULT_WEB_COMPONENT_DISCONNECT Default value for getWebComponentDisconnect() = 300.
static String	NOT_PRODUCTION_MODE_INFO
static String	NOT_PRODUCTION_MODE_WARNING
static String	WARNING_COMPATIBILITY_MODE
static String	WARNING_HEARTBEAT_INTERVAL_NOT_NUMERIC
static String	WARNING_LIVERELOAD_DISABLED_AND_NEW_LICENSE_CHECKER
static String	WARNING_PUSH_MODE_NOT_RECOGNIZED
static String	WARNING_XSRF_PROTECTION_DISABLED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
PushMode	getPushMode() Returns the mode of bidirectional ("push") client-server communication that should be used.
String	getPushURL() Returns the URL that bidirectional ("push") client-server communication should use.
int	getWebComponentDisconnect() Returns the number of seconds that a WebComponent will wait for a reconnect before removing the server-side component from memory.
boolean	isBowerMode() Deprecated.
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

getApplicationOrSystemProperty, getApplicationProperty, getInitParameters, getSystemProperty, isCompatibilityMode

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

getClassLoaderName, getUIClassName

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.function.DeploymentConfiguration

areWebJarsEnabled, disableAutomaticServletRegistration, enableDevServer, getBooleanProperty, getCompiledWebComponentsPath, getDevelopmentFrontendPrefix, getEs5FrontendPrefix, getEs6FrontendPrefix, getExternalStatsUrl, getNpmFrontendPrefix, getPolyfills, getStringProperty, isBrotli, isDevModeLiveReloadEnabled, isEnforcedFieldValidationEnabled, isOldLicenseCheckerEnabled, isPnpmEnabled, isStatsExternal, reuseDevServer, useCompiledFrontendResources

Field Detail

NOT_PRODUCTION_MODE_INFO

public static final String NOT_PRODUCTION_MODE_INFO

See Also:

Constant Field Values

WARNING_COMPATIBILITY_MODE

public static final String WARNING_COMPATIBILITY_MODE

See Also:

Constant Field Values

WARNING_LIVERELOAD_DISABLED_AND_NEW_LICENSE_CHECKER

public static final String WARNING_LIVERELOAD_DISABLED_AND_NEW_LICENSE_CHECKER

See Also:

Constant Field Values

NOT_PRODUCTION_MODE_WARNING

public static final String NOT_PRODUCTION_MODE_WARNING

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

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

DefaultDeploymentConfiguration

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

Create a new deployment configuration instance.

Parameters:

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 Detail

isProductionMode

public boolean isProductionMode()

Returns whether Vaadin is in production mode.

The default is false.

Specified by:

isProductionMode in interface DeploymentConfiguration

Overrides:

isProductionMode in class PropertyDeploymentConfiguration

Returns:

true if in production mode, false otherwise.

isBowerMode

@Deprecated
public boolean isBowerMode()

Deprecated.

Returns whether Vaadin is running in Vaadin 13 compatibility mode. NOTE: Compatibility mode is no longer supported by Flow since version 2.11. This method will throw a runtime exception when invoked. Throws UnsupportedOperationException if called when compatibility mode is enabled.

Specified by:

isBowerMode in interface DeploymentConfiguration

Overrides:

isBowerMode in class PropertyDeploymentConfiguration

Returns:

true if in compatibility 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 DeploymentConfiguration

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.

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.

getPushURL

public String getPushURL()

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

The default mode is "" which uses the servlet URL.

Specified by:

getPushURL in interface DeploymentConfiguration

Overrides:

getPushURL in class PropertyDeploymentConfiguration

Returns:

The push URL to use