com.vaadin.flow.server.startup

Interface ApplicationConfiguration

All Superinterfaces:

AbstractConfiguration, Serializable

All Known Implementing Classes:

DefaultApplicationConfigurationFactory.ApplicationConfigurationImpl

public interface ApplicationConfiguration
extends AbstractConfiguration

Configuration on the application level.

Configuration is based on VaadinContext which provides application level data in contrast to DeploymentConfiguration which provides a Servlet level configuration.

Since:

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method and Description
default boolean	disableAutomaticServletRegistration() Determines if Flow should automatically register servlets.
static ApplicationConfiguration	get(VaadinContext context) Gets a configuration instance for the given {code context}.
VaadinContext	getContext() The context which the configuration is based on.
FallbackChunk	getFallbackChunk() Gets a fallback chunk for the application or null if it's not available.
Enumeration<String>	getPropertyNames() Returns the names of the configuration properties as an Enumeration, or an empty Enumeration if there are o initialization parameters.
boolean	isDevModeSessionSerializationEnabled() Checks if development mode session serialization is enabled or not.

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

enableDevServer, getBooleanProperty, getBuildFolder, getFlowResourcesFolder, getJavaResourceFolder, getStringProperty, isGlobalPnpm, isPnpmEnabled, isProductionMode, isUsageStatisticsEnabled, isXsrfProtectionEnabled, reuseDevServer, useV14Bootstrap

Method Detail

get

static ApplicationConfiguration get(VaadinContext context)

Gets a configuration instance for the given {code context}.

Parameters:

context - the context to get the configuration for

Returns:

the application level configuration for the given context

getPropertyNames

Enumeration<String> getPropertyNames()

Returns the names of the configuration properties as an Enumeration, or an empty Enumeration if there are o initialization parameters.

Returns:

configuration properties as a Enumeration

getContext

VaadinContext getContext()

The context which the configuration is based on.

Returns:

the vaadin context

getFallbackChunk

FallbackChunk getFallbackChunk()

Gets a fallback chunk for the application or null if it's not available.

Returns:

the application fallback chunk, may be null.

isDevModeSessionSerializationEnabled

boolean isDevModeSessionSerializationEnabled()

Checks if development mode session serialization is enabled or not.

Disabling session serialization means all its UI instances won't be serialized. This might be needed if one or more UI's are not serializable and, thus, the whole http session might be discarded, making an authentication or other sensitive data stored in the session to get lost, which is not acceptable in most of the cases.

By default session serialization is disabled in development mode.

Returns:

true if dev mode session serialization is enabled, false otherwise

disableAutomaticServletRegistration

default boolean disableAutomaticServletRegistration()

Determines if Flow should automatically register servlets. For more information on the servlets registered, refer to ServletDeployer javadoc. User can explicitly disable automatic servlet registration by setting the InitParameters.DISABLE_AUTOMATIC_SERVLET_REGISTRATION property to true.

Returns:

true if Flow should not automatically register servlets

See Also:

ServletDeployer