DefaultDeploymentConfiguration (Vaadin Platform (vaadin-core) 11.0.4 API)

java.lang.Object
- com.vaadin.flow.server.AbstractDeploymentConfiguration
- - com.vaadin.flow.server.DefaultDeploymentConfiguration

All Implemented Interfaces:

DeploymentConfiguration, Serializable
```
public class DefaultDeploymentConfiguration
extends AbstractDeploymentConfiguration
```
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 boolean`	`DEFAULT_SEND_URLS_AS_PARAMETERS`
`static boolean`	`DEFAULT_SYNC_ID_CHECK` Default value for `isSyncIdCheckEnabled()` = true .
`static String`	`NOT_PRODUCTION_MODE_INFO`
`static String`	`WARNING_HEARTBEAT_INTERVAL_NOT_NUMERIC`
`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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`getApplicationOrSystemProperty(String propertyName, T defaultValue, Function<String,T> converter)` Gets a configured property.
`String`	`getApplicationProperty(String parameterName)` Gets an application property value.
`int`	`getHeartbeatInterval()` Returns the number of seconds between heartbeat requests of a UI, or a non-positive number if heartbeat is disabled.
`Properties`	`getInitParameters()` Gets the properties configured for the deployment, e.g.
`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.
`protected String`	`getSystemProperty(String parameterName)` Gets an system property value.
`boolean`	`isCloseIdleSessions()` Returns whether a 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.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, getBooleanProperty, getDevelopmentFrontendPrefix, getEs5FrontendPrefix, getEs6FrontendPrefix, getStringProperty, useCompiledFrontendResources

- Field Detail
  - 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
  - DEFAULT_HEARTBEAT_INTERVAL
```
public static final int DEFAULT_HEARTBEAT_INTERVAL
```
    Default value for getHeartbeatInterval() = 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
  - getApplicationOrSystemProperty
```
public <T> T getApplicationOrSystemProperty(String propertyName,
                                            T defaultValue,
                                            Function<String,T> converter)
```
    Description copied from interface: DeploymentConfiguration
    
    Gets a configured property. The properties are typically read from e.g. web.xml or from system properties of the JVM.
    
    Type Parameters:
    
    T - type of a property
    
    Parameters:
    
    propertyName - The simple of the property, in some contexts, lookup might be performed using variations of the provided name.
    
    defaultValue - the default value that should be used if no value has been defined
    
    converter - the way string should be converted into the required property
    
    Returns:
    
    the property value, or the passed default value if no property value is found
  - getSystemProperty
```
protected String getSystemProperty(String parameterName)
```
    Gets an system property value.
    
    Parameters:
    
    parameterName - the Name or the parameter.
    
    Returns:
    
    String value or null if not found
  - getApplicationProperty
```
public String getApplicationProperty(String parameterName)
```
    Gets an application property value.
    
    Parameters:
    
    parameterName - the Name or the parameter.
    
    Returns:
    
    String value or null if not found
  - isProductionMode
```
public boolean isProductionMode()
```
    Returns whether Vaadin is in production mode. The default is false.
    
    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.
    
    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.
    
    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).
    
    Returns:
    
    The time between heartbeats.
  - isCloseIdleSessions
```
public boolean isCloseIdleSessions()
```
    Returns whether a 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.
    
    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:
    
    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.
    
    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.
    
    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.
    
    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.
    
    Returns:
    
    The push URL to use
  - getInitParameters
```
public Properties getInitParameters()
```
    Description copied from interface: DeploymentConfiguration
    
    Gets the properties configured for the deployment, e.g. as init parameters to the servlet.
    
    Returns:
    
    properties for the application.

Class DefaultDeploymentConfiguration

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

NOT_PRODUCTION_MODE_INFO

WARNING_XSRF_PROTECTION_DISABLED

WARNING_HEARTBEAT_INTERVAL_NOT_NUMERIC

WARNING_PUSH_MODE_NOT_RECOGNIZED

DEFAULT_HEARTBEAT_INTERVAL

DEFAULT_CLOSE_IDLE_SESSIONS

DEFAULT_SYNC_ID_CHECK

DEFAULT_SEND_URLS_AS_PARAMETERS

Constructor Detail

DefaultDeploymentConfiguration

Method Detail

getApplicationOrSystemProperty

getSystemProperty

getApplicationProperty

isProductionMode

isRequestTiming

isXsrfProtectionEnabled

getHeartbeatInterval

isCloseIdleSessions

isSyncIdCheckEnabled

isSendUrlsAsParameters

getPushMode

getPushURL

getInitParameters