public interface DeploymentConfiguration extends Serializable
Modifier and Type | Method and Description |
---|---|
default boolean |
areWebJarsEnabled()
Determines if webJars mechanism is enabled.
|
default boolean |
disableAutomaticServletRegistration()
Determines if Flow should automatically register servlets.
|
<T> T |
getApplicationOrSystemProperty(String propertyName,
T defaultValue,
Function<String,T> converter)
Gets a configured property.
|
default boolean |
getBooleanProperty(String propertyName,
boolean defaultValue)
A shorthand of
getApplicationOrSystemProperty(String, Object, Function)
for String type. |
String |
getClassLoaderName()
Gets class loader configuration option value.
|
default String |
getDevelopmentFrontendPrefix()
Gets the URL from which frontend resources should be loaded during
development, unless explicitly configured to use the production es6 and
es5 URLs.
|
default String |
getEs5FrontendPrefix()
Gets the URL from which frontend resources should be loaded in ES5
compatible browsers.
|
default String |
getEs6FrontendPrefix()
Gets the URL from which frontend resources should be loaded in ES6
compatible browsers.
|
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.
|
default String |
getStringProperty(String propertyName,
String defaultValue)
A shorthand of
getApplicationOrSystemProperty(String, Object, Function)
for String type. |
String |
getUIClassName()
Gets UI class configuration option value.
|
default boolean |
isBrotli()
Checks whether precompressed Brotli files should be used if available.
|
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.
|
default boolean |
useCompiledFrontendResources()
Determines if Flow should use compiled or original frontend resources.
|
boolean isProductionMode()
boolean isRequestTiming()
boolean isXsrfProtectionEnabled()
boolean isSyncIdCheckEnabled()
true
if sync id checking is enabled;
false
otherwiseint getHeartbeatInterval()
boolean isSendUrlsAsParameters()
application/x-www-form-urlencoded
is enabled or not.false
if set to false or true
otherwiseboolean isCloseIdleSessions()
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.
WrappedSession.getMaxInactiveInterval()
PushMode getPushMode()
String getPushURL()
Properties getInitParameters()
<T> T getApplicationOrSystemProperty(String propertyName, T defaultValue, Function<String,T> converter)
T
- type of a propertypropertyName
- 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
definedconverter
- the way string should be converted into the required propertydefault String getStringProperty(String propertyName, String defaultValue)
getApplicationOrSystemProperty(String, Object, Function)
for String
type.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
defineddefault boolean getBooleanProperty(String propertyName, boolean defaultValue) throws IllegalArgumentException
getApplicationOrSystemProperty(String, Object, Function)
for String
type.
Considers ""
to be equal true
in order to treat params
like -Dtest.param
as enabled (test.param == true
).
Additionally validates the property value, requiring non-empty strings to
be equal to boolean string representation. An exception thrown if it's
not true.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
definedIllegalArgumentException
- if property value string is not a boolean valueString getUIClassName()
String getClassLoaderName()
default String getDevelopmentFrontendPrefix()
default String getEs6FrontendPrefix()
default String getEs5FrontendPrefix()
default boolean areWebJarsEnabled()
Constants.DISABLE_WEBJARS
property to
true
, or the user have not set the property at all and the
useCompiledFrontendResources()
returns false.true
if webJars are enabled, false
otherwisedefault boolean useCompiledFrontendResources()
Constants.USE_ORIGINAL_FRONTEND_RESOURCES
property to
true
.true
if Flow should use compiled frontend resources.default boolean disableAutomaticServletRegistration()
ServletDeployer
javadoc.
User can explicitly disable automatic servlet registration by setting the
Constants.DISABLE_AUTOMATIC_SERVLET_REGISTRATION
property to
true
.true
if Flow should not automatically register servletsServletDeployer
default boolean isBrotli()
true
to serve precompressed Brotli files,
false
to not serve Brotli files.Copyright © 2019. All rights reserved.