com.vaadin.server
Interface DeploymentConfiguration

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DefaultDeploymentConfiguration

public interface DeploymentConfiguration
extends java.io.Serializable

A collection of properties configured at deploy time as well as a way of accessing third party properties not explicitly supported by this class.

Since:

7.0.0

Version:

@VERSION@

Author:

Vaadin Ltd

Method Summary

java.lang.String	getApplicationOrSystemProperty(java.lang.String propertyName, java.lang.String defaultValue) Gets a configured property.
int	getHeartbeatInterval() Returns the number of seconds between heartbeat requests of a UI, or a non-positive number if heartbeat is disabled.
java.util.Properties	getInitParameters() Gets the properties configured for the deployment, e.g.
int	getResourceCacheTime() Returns the time resources can be cached in the browsers, in seconds.
boolean	isIdleUICleanupEnabled() Returns whether UIs that have no other activity than heartbeat requests should be removed from the session after they have been idle the maximum inactivity time enforced by the session.
boolean	isProductionMode() Returns whether Vaadin is in production mode.
boolean	isXsrfProtectionEnabled() Returns whether cross-site request forgery protection is enabled.

Method Detail

isProductionMode

boolean isProductionMode()

Returns whether Vaadin is in production mode.

Returns:

true if in production mode, false otherwise.

isXsrfProtectionEnabled

boolean isXsrfProtectionEnabled()

Returns whether cross-site request forgery protection is enabled.

Returns:

true if XSRF protection is enabled, false otherwise.

getResourceCacheTime

int getResourceCacheTime()

Returns the time resources can be cached in the browsers, in seconds.

Returns:

The resource cache time.

getHeartbeatInterval

int getHeartbeatInterval()

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

Returns:

The time between heartbeats.

isIdleUICleanupEnabled

boolean isIdleUICleanupEnabled()

Returns whether UIs that have no other activity than heartbeat requests should be removed from the session after they have been idle the maximum inactivity time enforced by the session.

Returns:

True if UIs receiving only heartbeat requests are eventually removed; false if heartbeat requests extend UI lifetime indefinitely.

Since:

7.0.0

See Also:

WrappedSession.getMaxInactiveInterval()

getInitParameters

java.util.Properties getInitParameters()

Gets the properties configured for the deployment, e.g. as init parameters to the servlet or portlet.

Returns:

properties for the application.

getApplicationOrSystemProperty

java.lang.String getApplicationOrSystemProperty(java.lang.String propertyName,
                                                java.lang.String defaultValue)

Gets a configured property. The properties are typically read from e.g. web.xml or from system properties of the JVM.

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

Returns:

the property value, or the passed default value if no property value is found