com.vaadin.terminal
Interface DeploymentConfiguration

All Superinterfaces:

Serializable

public interface DeploymentConfiguration
extends Serializable

Provide deployment specific settings that are required outside terminal specific code.

Since:

7.0

Author:

Vaadin Ltd.

Method Summary

String	getApplicationOrSystemProperty(String propertyName, String defaultValue) Gets a configured property.
ClassLoader	getClassLoader() Get the class loader to use for loading classes loaded by name, e.g.
String	getConfiguredTheme(WrappedRequest request) Gets the theme that is configured for this deployment, e.g.
String	getConfiguredWidgetset(WrappedRequest request) Gets the widgetset that is configured for this deployment, e.g.
String	getStaticFileLocation(WrappedRequest request) Gets the base URL of the location of Vaadin's static files.
boolean	isStandalone(WrappedRequest request) Checks whether the Vaadin application will be rendered on its own in the browser or whether it will be included into some other context.

Method Detail

getStaticFileLocation

String getStaticFileLocation(WrappedRequest request)

Gets the base URL of the location of Vaadin's static files.

Parameters:

request - the request for which the location should be determined

Returns:

a string with the base URL for static files

getConfiguredWidgetset

String getConfiguredWidgetset(WrappedRequest request)

Gets the widgetset that is configured for this deployment, e.g. from a parameter in web.xml.

Parameters:

request - the request for which a widgetset is required

Returns:

the name of the widgetset

getConfiguredTheme

String getConfiguredTheme(WrappedRequest request)

Gets the theme that is configured for this deployment, e.g. from a portal parameter or just some sensible default value.

Parameters:

request - the request for which a theme is required

Returns:

the name of the theme

isStandalone

boolean isStandalone(WrappedRequest request)

Checks whether the Vaadin application will be rendered on its own in the browser or whether it will be included into some other context. A standalone application may do things that might interfere with other parts of a page, e.g. changing the page title and requesting focus upon loading.

Parameters:

request - the request for which the application is loaded

Returns:

a boolean indicating whether the application should be standalone

getApplicationOrSystemProperty

String getApplicationOrSystemProperty(String propertyName,
                                      String defaultValue)

Gets a configured property. The properties are typically read from e.g. web.xml or from system properties of the JVM.

Parameters:

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 defined

Returns:

the property value, or the passed default value if no property value is found

getClassLoader

ClassLoader getClassLoader()

Get the class loader to use for loading classes loaded by name, e.g. custom Root classes. null indicates that the default class loader should be used.

Returns:

the class loader to use, or null