com.haulmont.cuba.web

Class App

java.lang.Object

com.haulmont.cuba.web.App

Direct Known Subclasses:

DefaultApp

public abstract class App
extends java.lang.Object

Central class of the web application. An instance of this class is created for each client's session and is bound to VaadinSession.
Use getInstance() static method to obtain the reference to the current App instance.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APP_THEME_COOKIE_PREFIX
static java.lang.String	COOKIE_LOCALE
static java.lang.String	NAME
static java.lang.String	USER_SESSION_ATTR

Constructor Summary

Constructors

Constructor and Description
App()

Method Summary

Modifier and Type	Method and Description
void	addBackgroundTask(java.util.concurrent.Future task)
void	addCookie(java.lang.String name, java.lang.String value)
void	addCookie(java.lang.String name, java.lang.String value, int maxAge)
void	cleanupBackgroundTasks()
void	closeAllWindows()
void	createTopLevelWindow()
void	createTopLevelWindow(AppUI ui) Called on each browser tab initialization.
AppLog	getAppLog()
AppUI	getAppUI()
java.util.List<AppUI>	getAppUIs()
java.lang.String	getClientAddress()
Connection	getConnection()
int	getCookieMaxAge(java.lang.String name)
java.lang.String	getCookieValue(java.lang.String name)
ExceptionHandlers	getExceptionHandlers()
static App	getInstance()
java.util.Locale	getLocale()
java.security.Principal	getPrincipal()
ThemeConstants	getThemeConstants()
Window.TopLevelWindow	getTopLevelWindow()
java.lang.String	getWebResourceTimestamp()
WebWindowManager	getWindowManager()
static boolean	isBound()
abstract boolean	loginOnStart()
void	logout() Try to perform logout.
void	logout(java.lang.Runnable runWhenLoggedOut) Try to perform logout.
void	navigateTo(java.lang.String topLevelWindowId) Initialize new TopLevelWindow and replace current
void	onHeartbeat() Called from heartbeat request.
void	pingExternalAuthentication()
void	removeBackgroundTask(java.util.concurrent.Future task)
void	removeCookie(java.lang.String name)
void	setLocale(java.util.Locale locale)
void	setUserAppTheme(java.lang.String themeName)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

USER_SESSION_ATTR

public static final java.lang.String USER_SESSION_ATTR

See Also:

Constant Field Values

APP_THEME_COOKIE_PREFIX

public static final java.lang.String APP_THEME_COOKIE_PREFIX

See Also:

Constant Field Values

COOKIE_LOCALE

public static final java.lang.String COOKIE_LOCALE

See Also:

Constant Field Values

Constructor Detail

App

public App()

Method Detail

getTopLevelWindow

public Window.TopLevelWindow getTopLevelWindow()

Returns:

currently displayed top-level window

getAppUI

public AppUI getAppUI()

Returns:

current UI

getThemeConstants

public ThemeConstants getThemeConstants()

getAppUIs

public java.util.List<AppUI> getAppUIs()

loginOnStart

public abstract boolean loginOnStart()

createTopLevelWindow

public void createTopLevelWindow(AppUI ui)

Called on each browser tab initialization.

createTopLevelWindow

public void createTopLevelWindow()

navigateTo

public void navigateTo(java.lang.String topLevelWindowId)

Initialize new TopLevelWindow and replace current

Parameters:

topLevelWindowId - target top level window id

onHeartbeat

public void onHeartbeat()

Called from heartbeat request.
Used for ping middleware session and show session messages

pingExternalAuthentication

public void pingExternalAuthentication()

getInstance

public static App getInstance()

Returns:

Current App instance. Can be invoked anywhere in application code.

Throws:

java.lang.IllegalStateException - if no application instance is bound to the current VaadinSession

isBound

public static boolean isBound()

Returns:

true if an App instance is currently bound and can be safely obtained by getInstance()

getConnection

public Connection getConnection()

Returns:

Current connection object

getWindowManager

public WebWindowManager getWindowManager()

Returns:

WindowManager instance or null if the current UI has no MainWindow

getAppLog

public AppLog getAppLog()

getExceptionHandlers

public ExceptionHandlers getExceptionHandlers()

getCookieValue

public java.lang.String getCookieValue(java.lang.String name)

getCookieMaxAge

public int getCookieMaxAge(java.lang.String name)

addCookie

public void addCookie(java.lang.String name,
                      java.lang.String value,
                      int maxAge)

addCookie

public void addCookie(java.lang.String name,
                      java.lang.String value)

removeCookie

public void removeCookie(java.lang.String name)

getPrincipal

public java.security.Principal getPrincipal()

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale)

getClientAddress

public java.lang.String getClientAddress()

setUserAppTheme

public void setUserAppTheme(java.lang.String themeName)

getWebResourceTimestamp

public java.lang.String getWebResourceTimestamp()

addBackgroundTask

public void addBackgroundTask(java.util.concurrent.Future task)

removeBackgroundTask

public void removeBackgroundTask(java.util.concurrent.Future task)

cleanupBackgroundTasks

public void cleanupBackgroundTasks()

closeAllWindows

public void closeAllWindows()

logout

public void logout()

Try to perform logout. If there are unsaved changes in opened windows then logout will not be performed and unsaved changes dialog will appear.

logout

public void logout(@Nullable
                   java.lang.Runnable runWhenLoggedOut)

Try to perform logout. If there are unsaved changes in opened windows then logout will not be performed and unsaved changes dialog will appear.

Parameters:

runWhenLoggedOut - runnable that will be invoked if user decides to logout