io.jmix.ui

Class App

java.lang.Object

io.jmix.ui.App

Direct Known Subclasses:

JmixApp

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
protected org.springframework.context.ApplicationContext	applicationContext
protected BackgroundTaskManager	backgroundTaskManager
static java.lang.String	COOKIE_LOCALE
static java.lang.String	COOKIE_LOGIN
static java.lang.String	COOKIE_PASSWORD
static java.lang.String	COOKIE_REMEMBER_ME
protected AppCookies	cookies
protected io.jmix.core.CoreProperties	coreProperties
static java.lang.String	DEFAULT_THEME_NAME
protected ExceptionHandlers	exceptionHandlers
protected LinkHandler	linkHandler
protected io.jmix.core.MessageTools	messageTools
protected javax.servlet.ServletContext	servletContext
protected UiSettingsCache	settingsCache
protected ThemeConstants	themeConstants
protected ThemeConstantsRepository	themeConstantsRepository
protected UiProperties	uiProperties
protected UiThemeProperties	uiThemeProperties
static java.lang.String	USER_SESSION_ATTR
protected WindowConfig	windowConfig

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)
protected void	applyTheme(java.lang.String appWindowTheme)
void	cleanupBackgroundTasks()
protected void	clearSettingsCache()
void	closeWindowsInternal(boolean fireEvent) Removes all windows from all UIs and fires CloseWindowsInternalEvent application event.
void	createTopLevelWindow()
void	createTopLevelWindow(AppUI ui) Called on each browser tab initialization.
protected void	forceLogout()
java.util.List<AppUI>	getAppUIs()
protected java.lang.String	getContextPathName()
int	getCookieMaxAge(java.lang.String name)
java.lang.String	getCookieValue(java.lang.String name)
ExceptionHandlers	getExceptionHandlers()
static App	getInstance()
java.util.Locale	getLocale()
ThemeConstants	getThemeConstants()
ScreensImpl	getWindowManager() Deprecated. Get screens API from AppUI instead.
protected void	init(java.util.Locale requestLocale) Called when the first UI of the session is initialized.
protected void	initExceptionHandlers(boolean isConnected) Initializes exception handlers immediately after login and logout.
static boolean	isBound()
protected ThemeConstants	loadTheme()
abstract void	loginOnStart()
OperationResult	logout() Try to perform logout.
void	navigateTo(java.lang.String topLevelWindowId) Deprecated. Use Screens.create(Class, OpenMode) with OpenMode.ROOT
void	onHeartbeat() Called from heartbeat request.
protected void	performForceLogout()
protected void	performStandardLogout(AppUI ui)
void	removeAllWindows() Removes all windows from all UIs.
protected void	removeAllWindows(java.util.List<AppUI> uis) Removes all windows in the given uis.
void	removeBackgroundTask(java.util.concurrent.Future task)
void	removeCookie(java.lang.String name)
protected java.util.Locale	resolveLocale(java.util.Locale requestLocale)
protected abstract java.lang.String	routeTopLevelWindowId()
void	setLocale(java.util.Locale locale)
void	setUserAppTheme(java.lang.String themeName)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_THEME_NAME

public static final java.lang.String DEFAULT_THEME_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

COOKIE_REMEMBER_ME

public static final java.lang.String COOKIE_REMEMBER_ME

See Also:

Constant Field Values

COOKIE_LOGIN

public static final java.lang.String COOKIE_LOGIN

See Also:

Constant Field Values

COOKIE_PASSWORD

public static final java.lang.String COOKIE_PASSWORD

See Also:

Constant Field Values

exceptionHandlers

protected ExceptionHandlers exceptionHandlers

coreProperties

@Autowired
protected io.jmix.core.CoreProperties coreProperties

servletContext

@Autowired(required=false)
protected javax.servlet.ServletContext servletContext

windowConfig

@Autowired
protected WindowConfig windowConfig

themeConstantsRepository

@Autowired
protected ThemeConstantsRepository themeConstantsRepository

messageTools

@Autowired
protected io.jmix.core.MessageTools messageTools

settingsCache

@Autowired(required=false)
protected UiSettingsCache settingsCache

applicationContext

@Autowired
protected org.springframework.context.ApplicationContext applicationContext

uiProperties

@Autowired
protected UiProperties uiProperties

uiThemeProperties

@Autowired
protected UiThemeProperties uiThemeProperties

cookies

protected AppCookies cookies

linkHandler

protected LinkHandler linkHandler

backgroundTaskManager

protected BackgroundTaskManager backgroundTaskManager

themeConstants

protected ThemeConstants themeConstants

Constructor Detail

App

public App()

Method Detail

loadTheme

protected ThemeConstants loadTheme()

applyTheme

protected void applyTheme(java.lang.String appWindowTheme)

initExceptionHandlers

protected void initExceptionHandlers(boolean isConnected)

Initializes exception handlers immediately after login and logout. Can be overridden in descendants to manipulate exception handlers programmatically.

Parameters:

isConnected - true after login, false after logout

getThemeConstants

public ThemeConstants getThemeConstants()

getAppUIs

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

loginOnStart

public abstract void loginOnStart()

init

protected void init(java.util.Locale requestLocale)

Called when the first UI of the session is initialized.

resolveLocale

protected java.util.Locale resolveLocale(@Nullable
                                         java.util.Locale requestLocale)

createTopLevelWindow

public void createTopLevelWindow(AppUI ui)

Called on each browser tab initialization.

routeTopLevelWindowId

protected abstract java.lang.String routeTopLevelWindowId()

createTopLevelWindow

public void createTopLevelWindow()

navigateTo

@Deprecated
public void navigateTo(java.lang.String topLevelWindowId)

Deprecated. Use Screens.create(Class, OpenMode) with OpenMode.ROOT

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

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()

getWindowManager

@Deprecated
 @Nullable
public ScreensImpl getWindowManager()

Deprecated. Get screens API from AppUI instead.

Returns:

WindowManagerImpl instance or null if the current UI has no MainWindow

getExceptionHandlers

public ExceptionHandlers getExceptionHandlers()

getCookieValue

@Nullable
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)

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale)

setUserAppTheme

public void setUserAppTheme(java.lang.String themeName)

addBackgroundTask

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

removeBackgroundTask

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

cleanupBackgroundTasks

public void cleanupBackgroundTasks()

removeAllWindows

public void removeAllWindows()

Removes all windows from all UIs.

removeAllWindows

protected void removeAllWindows(java.util.List<AppUI> uis)

Removes all windows in the given uis.

Parameters:

uis - AppUI instances

logout

public OperationResult 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.

Returns:

operation result object

performStandardLogout

protected void performStandardLogout(AppUI ui)

performForceLogout

protected void performForceLogout()

forceLogout

protected void forceLogout()

closeWindowsInternal

public void closeWindowsInternal(boolean fireEvent)

Removes all windows from all UIs and fires CloseWindowsInternalEvent application event.

Parameters:

fireEvent - fire event or not

getContextPathName

@Nullable
protected java.lang.String getContextPathName()

clearSettingsCache

protected void clearSettingsCache()