com.vaadin.client

Class ApplicationConfiguration

java.lang.Object

com.vaadin.client.ApplicationConfiguration

public class ApplicationConfiguration
extends Object

Application configuration data.

This class is effectively immutable although setters exist to assign the values during construction.

Since:

1.0

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor and Description
ApplicationConfiguration()

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() Gets the id generated for the application.
String	getAtmosphereJSVersion() Gets the Atmosphere JavaScript version in use.
String	getAtmosphereVersion() Gets the Atmosphere runtime version in use.
String	getContextRootUrl() Gets the URL of the context root on the server.
String[]	getExportedWebComponents() Gets the exported web components.
String	getFrontendRootUrl() Gets the base URL of the frontend components on the server.
int	getHeartbeatInterval() Gets the interval for heartbeat requests.
String	getLiveReloadBackend() Gets the the live reload backend technology identifier.
String	getLiveReloadUrl() Gets the URL for the live reload websocket connection.
int	getMaxMessageSuspendTimeout() Gets the maximum message suspension delay.
String	getServiceUrl() Gets the URL to the server-side VaadinService.
String	getServletVersion() Gets the Vaadin servlet version in use.
ErrorMessage	getSessionExpiredError() Gets the message used when a session expiration error occurs.
String	getSpringBootLiveReloadPort() Gets the Spring boot live reload port.
int	getUIId() Gets the UI id of the server-side UI associated with this client-side instance.
boolean	isDevmodeGizmoEnabled() Gets if development mode gizmo should be added to the page.
boolean	isProductionMode() Checks if we are running in production mode.
boolean	isRequestTiming() Checks if request timing info should be made available.
boolean	isWebComponentMode() Checks whether the application is running as a web-component in the page.
void	setApplicationId(String applicationId) Sets the id generated for the application.
void	setAtmosphereJSVersion(String atmosphereJSVersion) Sets the Atmosphere JavaScript version in use.
void	setAtmosphereVersion(String atmosphereVersion) Sets the Atmosphere runtime version in use.
void	setContextRootUrl(String contextRootUrl) Sets the URL of the context root on the server.
void	setDevmodeGizmoEnabled(boolean devmodeGizmoEnabled) Sets if development mode gizmo should be added to the page.
void	setExportedWebComponents(String[] exportedWebComponents) Sets the exported web components.
void	setFrontendRootUrl(String frontendRootUrl) Sets the base URL of the frontend components on the server.
void	setHeartbeatInterval(int heartbeatInterval) Sets the interval for heartbeat requests.
void	setLiveReloadBackend(String liveReloadBackend) Sets the live reload backend technology identifier.
void	setLiveReloadUrl(String liveReloadUrl) Sets the URL for the live reload websocket connection.
void	setMaxMessageSuspendTimeout(int maxMessageSuspendTimeout) Sets the maximum message suspension delay.
void	setProductionMode(boolean productionMode) Sets whether we are running in production mode.
void	setRequestTiming(boolean requestTiming) Sets whether request timing info should be made available.
void	setServiceUrl(String serviceUrl) Sets the URL to the server-side VaadinService.
void	setServletVersion(String servletVersion) Sets the Vaadin servlet version in use.
void	setSessionExpiredError(ErrorMessage sessionExpiredError) Sets the message used when a session expiration error occurs.
void	setSpringBootLiveReloadPort(String springBootLiveReloadPort) Sets the Spring boot live reload port.
void	setUIId(int uiId) Sets the UI id of the server-side UI associated with this client-side instance.
void	setWebComponentMode(boolean mode) Sets whether the application is running as a web-component in the page.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationConfiguration

public ApplicationConfiguration()

Method Detail

getApplicationId

public String getApplicationId()

Gets the id generated for the application.

Returns:

the id for the application

setApplicationId

public void setApplicationId(String applicationId)

Sets the id generated for the application.

Parameters:

applicationId - the id for the application

getServiceUrl

public String getServiceUrl()

Gets the URL to the server-side VaadinService.

Returns:

the URL to the server-side service as a string

setServiceUrl

public void setServiceUrl(String serviceUrl)

Sets the URL to the server-side VaadinService.

Parameters:

serviceUrl - the URL to the server-side service as a string

getContextRootUrl

public String getContextRootUrl()

Gets the URL of the context root on the server.

Returns:

the URL of the context root, ending with a "/"

setContextRootUrl

public void setContextRootUrl(String contextRootUrl)

Sets the URL of the context root on the server.

Parameters:

contextRootUrl - the URL of the context root, ending with a "/"

isWebComponentMode

public boolean isWebComponentMode()

Checks whether the application is running as a web-component in the page.

Returns:

true in case the app is a WC

setWebComponentMode

public void setWebComponentMode(boolean mode)

Sets whether the application is running as a web-component in the page.

Parameters:

mode - set to true if it's a WC

getUIId

public int getUIId()

Gets the UI id of the server-side UI associated with this client-side instance. The UI id should be included in every request originating from this instance in order to associate the request with the right UI instance on the server.

Returns:

the UI id

setUIId

public void setUIId(int uiId)

Sets the UI id of the server-side UI associated with this client-side instance.

Parameters:

uiId - the UI id

getHeartbeatInterval

public int getHeartbeatInterval()

Gets the interval for heartbeat requests.

Returns:

The interval in seconds between heartbeat requests, or -1 if heartbeat is disabled.

setHeartbeatInterval

public void setHeartbeatInterval(int heartbeatInterval)

Sets the interval for heartbeat requests.

Parameters:

heartbeatInterval - The interval in seconds between heartbeat requests, or -1 if heartbeat is disabled.

getMaxMessageSuspendTimeout

public int getMaxMessageSuspendTimeout()

Gets the maximum message suspension delay.

Returns:

The maximum time, in milliseconds, to suspend out-of-order messages waiting for their predecessor before resynchronizing.

setMaxMessageSuspendTimeout

public void setMaxMessageSuspendTimeout(int maxMessageSuspendTimeout)

Sets the maximum message suspension delay.

Parameters:

maxMessageSuspendTimeout - The maximum time, in milliseconds, to suspend out-of-order messages waiting for their predecessor before resynchronizing.

getSessionExpiredError

public ErrorMessage getSessionExpiredError()

Gets the message used when a session expiration error occurs.

Returns:

the session expiration error message

setSessionExpiredError

public void setSessionExpiredError(ErrorMessage sessionExpiredError)

Sets the message used when a session expiration error occurs.

Parameters:

sessionExpiredError - the session expiration error message

getServletVersion

public String getServletVersion()

Gets the Vaadin servlet version in use.

Returns:

the Vaadin servlet version in use

setServletVersion

public void setServletVersion(String servletVersion)

Sets the Vaadin servlet version in use.

Parameters:

servletVersion - the Vaadin servlet version in use

getAtmosphereVersion

public String getAtmosphereVersion()

Gets the Atmosphere runtime version in use.

Returns:

the Atmosphere runtime version in use

setAtmosphereVersion

public void setAtmosphereVersion(String atmosphereVersion)

Sets the Atmosphere runtime version in use.

Parameters:

atmosphereVersion - the Atmosphere runtime version in use

getAtmosphereJSVersion

public String getAtmosphereJSVersion()

Gets the Atmosphere JavaScript version in use.

Returns:

the Atmosphere JavaScript version in use

setAtmosphereJSVersion

public void setAtmosphereJSVersion(String atmosphereJSVersion)

Sets the Atmosphere JavaScript version in use.

Parameters:

atmosphereJSVersion - the Atmosphere JavaScript version in use

isProductionMode

public boolean isProductionMode()

Checks if we are running in production mode.

With production mode disabled, a lot more information is logged to the browser console. In production you should always enable production mode, because logging and other debug features can have a significant performance impact.

Returns:

true if production mode is enabled, false otherwise

isRequestTiming

public boolean isRequestTiming()

Checks if request timing info should be made available.

Returns:

true if request timing info should be made availble, false otherwise

setProductionMode

public void setProductionMode(boolean productionMode)

Sets whether we are running in production mode.

With production mode disabled, a lot more information is logged to the browser console. In production you should always enable production mode, because logging and other debug features can have a significant performance impact.

Parameters:

productionMode - true if production mode is enabled, false otherwise

setRequestTiming

public void setRequestTiming(boolean requestTiming)

Sets whether request timing info should be made available.

Parameters:

requestTiming - true if request timing info should be made available, false otherwise

getFrontendRootUrl

public String getFrontendRootUrl()

Gets the base URL of the frontend components on the server.

Returns:

the base URL on the server for the frontend:// protocol.

setFrontendRootUrl

public void setFrontendRootUrl(String frontendRootUrl)

Sets the base URL of the frontend components on the server.

Parameters:

frontendRootUrl - the base URL on the server for the frontend:// protocol.

setExportedWebComponents

public void setExportedWebComponents(String[] exportedWebComponents)

Sets the exported web components.

Parameters:

exportedWebComponents - the exported web components

getExportedWebComponents

public String[] getExportedWebComponents()

Gets the exported web components.

Returns:

the exported web components

isDevmodeGizmoEnabled

public boolean isDevmodeGizmoEnabled()

Gets if development mode gizmo should be added to the page.

Returns:

whether development mode gizmo should be added

setDevmodeGizmoEnabled

public void setDevmodeGizmoEnabled(boolean devmodeGizmoEnabled)

Sets if development mode gizmo should be added to the page.

Parameters:

devmodeGizmoEnabled - whether development mode gizmo should be added

getLiveReloadUrl

public String getLiveReloadUrl()

Gets the URL for the live reload websocket connection.

Returns:

URL for the live reload websocket connection

setLiveReloadUrl

public void setLiveReloadUrl(String liveReloadUrl)

Sets the URL for the live reload websocket connection.

Parameters:

liveReloadUrl - URL for the live reload websocket connection

getLiveReloadBackend

public String getLiveReloadBackend()

Gets the the live reload backend technology identifier.

Returns:

the live reload backend technology identifier

setLiveReloadBackend

public void setLiveReloadBackend(String liveReloadBackend)

Sets the live reload backend technology identifier.

Parameters:

liveReloadBackend - the live reload backend technology identifier

getSpringBootLiveReloadPort

public String getSpringBootLiveReloadPort()

Gets the Spring boot live reload port.

Returns:

the Spring boot live reload port

setSpringBootLiveReloadPort

public void setSpringBootLiveReloadPort(String springBootLiveReloadPort)

Sets the Spring boot live reload port.

Parameters:

springBootLiveReloadPort - the Spring boot live reload port