Package com.vaadin.server

Class AbstractDeploymentConfiguration

java.lang.Object

com.vaadin.server.AbstractDeploymentConfiguration

All Implemented Interfaces:

DeploymentConfiguration, Serializable

Direct Known Subclasses:

DefaultDeploymentConfiguration

public abstract class AbstractDeploymentConfiguration
extends Object
implements DeploymentConfiguration

An abstract base class for DeploymentConfiguration implementations. This class provides default implementation for common config properties.

Since:

7.4

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractDeploymentConfiguration()

Method Summary

Modifier and Type	Method	Description
String	getClassLoaderName()	Gets class loader configuration option value.
String	getResourcesPath()	Gets resources path configuration option value.
String	getUIClassName()	Gets UI class configuration option value.
String	getUIProviderClassName()	Gets UI provider class configuration option value.
int	getUIProviderPriority()	Get the priority of the designated/default UI provider.
Set<String>	getUrlSafeSchemes()	Returns the set of URL schemes considered safe in URLs set on components using ExternalResource (such as Image, Link, and FileDownloader) as well as methods such as Page.open(String, String) and Page.setLocation(String).
String	getWidgetset(String defaultValue)	Gets Widgetset configuration option value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.server.DeploymentConfiguration

getApplicationOrSystemProperty, getHeartbeatInterval, getInitParameters, getMaxRequestBodySize, getPushMode, getResourceCacheTime, isCloseIdleSessions, isProductionMode, isSendUrlsAsParameters, isSyncIdCheckEnabled, isXsrfProtectionEnabled

Constructor Detail

AbstractDeploymentConfiguration

public AbstractDeploymentConfiguration()

Method Detail

getUIClassName

public String getUIClassName()

Description copied from interface: DeploymentConfiguration

Gets UI class configuration option value.

Specified by:

getUIClassName in interface DeploymentConfiguration

Returns:

UI class name

getUIProviderClassName

public String getUIProviderClassName()

Description copied from interface: DeploymentConfiguration

Gets UI provider class configuration option value.

Specified by:

getUIProviderClassName in interface DeploymentConfiguration

Returns:

UI class name

getUIProviderPriority

public int getUIProviderPriority()

Description copied from interface: DeploymentConfiguration

Get the priority of the designated/default UI provider. Higher values are served first. The default value of 0 retains old behavior.

Specified by:

getUIProviderPriority in interface DeploymentConfiguration

Returns:

UI provider priority (defaults to 0)

getWidgetset

public String getWidgetset(String defaultValue)

Description copied from interface: DeploymentConfiguration

Gets Widgetset configuration option value. defaultValue is returned if widgetset parameter is not configured.

Specified by:

getWidgetset in interface DeploymentConfiguration

Returns:

UI class name

getResourcesPath

public String getResourcesPath()

Description copied from interface: DeploymentConfiguration

Gets resources path configuration option value.

Specified by:

getResourcesPath in interface DeploymentConfiguration

getClassLoaderName

public String getClassLoaderName()

Description copied from interface: DeploymentConfiguration

Gets class loader configuration option value.

Specified by:

getClassLoaderName in interface DeploymentConfiguration

getUrlSafeSchemes

public Set<String> getUrlSafeSchemes()

Description copied from interface: DeploymentConfiguration

Returns the set of URL schemes considered safe in URLs set on components using ExternalResource (such as Image, Link, and FileDownloader) as well as methods such as Page.open(String, String) and Page.setLocation(String).

Concrete implementations read this from the Constants.URL_SAFE_SCHEMES property; the default returns a singleton set of Constants.URL_SAFE_SCHEMES_WILDCARD, which bypasses the validation and allows all URLs.

Note: the default and how it's applied changes in modern Vaadin versions. As of July 2026, the Flow versions that support this feature only apply the validation to Anchor, IFrame, Page#open, and Page#setLocation, and bypass e.g. Image and download handling. Also, starting from Vaadin 25.2, the default safe schemes are http, https, mailto, tel and ftp). Script-capable schemes such as javascript and data are intentionally excluded from the Vaadin 25.2 safe URL schemes. Because of technical differences in how Flow and Vaadin 8 handle URLs it is not possible to target the exact same classes here. The wildcard default in versions before Vaadin 25.2 was chosen for backwards compatibility.

Specified by:

getUrlSafeSchemes in interface DeploymentConfiguration

Returns:

the set of safe URL schemes, never null