com.vaadin.flow.spring

Class VaadinConfigurationProperties

java.lang.Object

com.vaadin.flow.spring.VaadinConfigurationProperties

@ConfigurationProperties(prefix="vaadin")
public class VaadinConfigurationProperties
extends Object

Configuration properties for Vaadin Spring Boot.

Author:

Vaadin Ltd

See Also:

http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VaadinConfigurationProperties.Pnpm

Constructor Summary

Constructors

Constructor and Description
VaadinConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
List<String>	getAllowedPackages() Get a list of packages that are allowed for class scanning.
List<String>	getBlacklistedPackages() Deprecated. use getBlockedPackages()
List<String>	getBlockedPackages() Get a list of packages that are blocked for class scanning.
String	getUrlMapping() Gets the url mapping for the Vaadin servlet.
List<String>	getWhitelistedPackages() Deprecated. use getAllowedPackages()
boolean	isAsyncSupported() Returns if asynchronous operations are supported.
boolean	isLaunchBrowser() Returns if a browser should be launched on startup when in development mode.
boolean	isLoadOnStartup() Returns if servlet is loaded on startup.
boolean	isPnpmEnabled() Returns if pnpm support is enabled.
void	setAllowedPackages(List<String> allowedPackages) Set list of packages to be scanned.
void	setAsyncSupported(boolean asyncSupported) Sets asyncSupported property value.
void	setBlacklistedPackages(List<String> blockedPackages) Deprecated. use setBlockedPackages()
void	setBlockedPackages(List<String> blockedPackages) Set a list of packages to ignore for class scanning.
void	setLaunchBrowser(boolean launchBrowser) Sets whether a browser should be launched on startup when in development mode.
void	setLoadOnStartup(boolean loadOnStartup) Sets whether servlet is loaded on startup.
void	setPnpmEnabled(boolean enabled) Enables/disabled pnpm support.
void	setUrlMapping(String urlMapping) Sets urlMapping property value.
void	setWhitelistedPackages(List<String> allowedPackages) Deprecated. use setAllowedPackages()

Methods inherited from class java.lang.Object

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

Constructor Detail

VaadinConfigurationProperties

public VaadinConfigurationProperties()

Method Detail

getUrlMapping

public String getUrlMapping()

Gets the url mapping for the Vaadin servlet.

Returns:

the url mapping

setUrlMapping

public void setUrlMapping(String urlMapping)

Sets urlMapping property value.

Parameters:

urlMapping - the urlMapping property value

isAsyncSupported

public boolean isAsyncSupported()

Returns if asynchronous operations are supported.

Returns:

if async is supported

setAsyncSupported

public void setAsyncSupported(boolean asyncSupported)

Sets asyncSupported property value.

Parameters:

asyncSupported - the asyncSupported property value

isLoadOnStartup

public boolean isLoadOnStartup()

Returns if servlet is loaded on startup.

If the servlet is not loaded on startup then the first request to the server might be incorrectly handled by VaadinWebSecurityConfigurerAdapter and access to a public view will be denied instead of allowed.

Returns:

if servlet is loaded on startup

setLoadOnStartup

public void setLoadOnStartup(boolean loadOnStartup)

Sets whether servlet is loaded on startup.

If the servlet is not loaded on startup then the first request to the server might be incorrectly handled by VaadinWebSecurityConfigurerAdapter and access to a public view will be denied instead of allowed.

Parameters:

loadOnStartup - true to load the servlet on startup, false otherwise

isLaunchBrowser

public boolean isLaunchBrowser()

Returns if a browser should be launched on startup when in development mode.

Returns:

if a browser should be launched on startup when in development mode

setLaunchBrowser

public void setLaunchBrowser(boolean launchBrowser)

Sets whether a browser should be launched on startup when in development mode.

Parameters:

launchBrowser - true to launch a browser on startup when in development mode, false otherwise

isPnpmEnabled

public boolean isPnpmEnabled()

Returns if pnpm support is enabled.

Returns:

if pnpm is enabled

setPnpmEnabled

public void setPnpmEnabled(boolean enabled)

Enables/disabled pnpm support.

Parameters:

enabled - if true then pnpm support is enabled, otherwise it's disabled

getBlacklistedPackages

@Deprecated
public List<String> getBlacklistedPackages()

Deprecated. use getBlockedPackages()

Get a list of packages that are blocked for class scanning.

Returns:

blocked packages

getBlockedPackages

public List<String> getBlockedPackages()

Get a list of packages that are blocked for class scanning.

Returns:

blocked packages

setBlacklistedPackages

@Deprecated
public void setBlacklistedPackages(List<String> blockedPackages)

Deprecated. use setBlockedPackages()

Set a list of packages to ignore for class scanning.

Parameters:

blockedPackages - list of packages to ignore

setBlockedPackages

public void setBlockedPackages(List<String> blockedPackages)

Set a list of packages to ignore for class scanning.

Parameters:

blockedPackages - list of packages to ignore

getWhitelistedPackages

@Deprecated
public List<String> getWhitelistedPackages()

Deprecated. use getAllowedPackages()

Get a list of packages that are allowed for class scanning.

Returns:

allowed packages

getAllowedPackages

public List<String> getAllowedPackages()

Get a list of packages that are allowed for class scanning.

Returns:

allowed packages

setWhitelistedPackages

@Deprecated
public void setWhitelistedPackages(List<String> allowedPackages)

Deprecated. use setAllowedPackages()

Set list of packages to be scanned. If allowedPackages is set then blockedPackages is ignored.

Parameters:

allowedPackages - list of packages to be scanned

setAllowedPackages

public void setAllowedPackages(List<String> allowedPackages)

Set list of packages to be scanned. If allowedPackages is set then blockedPackages is ignored.

Parameters:

allowedPackages - list of packages to be scanned