Package org.teamapps.ux.session

Class SessionContext

java.lang.Object

org.teamapps.ux.session.SessionContext

public class SessionContext
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
ExecutionDecoratorStack	executionDecorators	Decorators around all executions inside this SessionContext.
Event<UiSessionActivityState>	onActivityStateChanged
Event<java.lang.Void>	onDestroyed

Constructor Summary

Constructors

Constructor	Description
SessionContext(QualifiedUiSessionId sessionId, ClientInfo clientInfo, javax.servlet.http.HttpSession httpSession, UiCommandExecutor commandExecutor, UxServerContext serverContext, org.teamapps.icons.api.IconTheme iconTheme, com.fasterxml.jackson.databind.ObjectMapper jacksonObjectMapper)

Method Summary

Modifier and Type	Method	Description
void	addClientToken(java.lang.String token)
void	addExecutionDecorator(ExecutionDecorator decorator, boolean outer)	Adds a decorator that gets invoked whenever a Thread is bound to this SessionContext.
void	addRootComponent(java.lang.String containerElementId, RootPanel rootPanel)
void	clearClientTokens()
java.lang.String	createFileLink(java.io.File file)
java.lang.String	createResourceLink(Resource resource)
java.lang.String	createResourceLink(Resource resource, java.lang.String uniqueIdentifier)
static SessionContext	current()
static SessionContext	currentOrNull()
void	destroy()
void	downloadFile(java.lang.String fileUrl, java.lang.String downloadFileName)
void	exitFullScreen()
void	flushCommands()	Deprecated. no more needed.
Resource	getBinaryResource(int resourceId)
ClientBackPressureInfo	getClientBackPressureInfo()
ClientInfo	getClientInfo()
ClientObject	getClientObject(java.lang.String clientObjectId)
SessionConfiguration	getConfiguration()
javax.servlet.http.HttpSession	getHttpSession()
org.teamapps.icons.api.IconTheme	getIconTheme()
java.util.Locale	getLanguageLocale()
java.util.Locale	getLocale()
java.lang.String	getLocalized(java.lang.String key, java.lang.Object... parameters)
java.util.ResourceBundle	getMessageBundle()
Template	getTemplate(java.lang.String id)
java.time.ZoneId	getTimeZone()
java.io.File	getUploadedFileByUuid(java.lang.String uuid)
void	handleActivityStateChangedInternal(boolean active)
void	handleSessionDestroyedInternal()
boolean	isActive()
boolean	isDestroyed()
Event<java.lang.Void>	onDestroyed()
<RESULT> void	queueCommand(org.teamapps.dto.UiCommand<RESULT> command)
<RESULT> void	queueCommand(org.teamapps.dto.UiCommand<RESULT> command, java.util.function.Consumer<RESULT> resultCallback)
void	registerBackgroundImage(java.lang.String id, java.lang.String image, java.lang.String blurredImage)
void	registerClientObject(ClientObject clientObject)
TemplateReference	registerTemplate(java.lang.String id, Template template)
void	registerTemplates(java.util.Map<java.lang.String,Template> templates)
void	removeClientToken(java.lang.String token)
java.lang.String	resolveIcon(org.teamapps.icons.api.Icon icon)
java.util.concurrent.CompletableFuture<java.lang.Void>	runWithContext(java.lang.Runnable runnable)
java.util.concurrent.CompletableFuture<java.lang.Void>	runWithContext(java.lang.Runnable runnable, boolean forceEnqueue)
void	setBackgroundColor(org.teamapps.common.format.Color color, int animationDuration)
void	setBackgroundImage(java.lang.String id, int animationDuration)
void	setConfiguration(SessionConfiguration config)
void	setCustomMessageBundleProvider(java.util.function.Function<java.util.Locale,java.util.ResourceBundle> provider)
void	setIconTheme(org.teamapps.icons.api.IconTheme theme)
void	showNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption)
void	showNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption, java.lang.String description)
void	showNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption, java.lang.String description, boolean dismissable, int displayTimeInMillis, boolean showProgress)
void	showNotification(Notification notification, NotificationPosition position)
void	showNotification(Notification notification, NotificationPosition position, EntranceAnimation entranceAnimation, ExitAnimation exitAnimation)
void	showPopup(Popup popup)
void	showPopupAtCurrentMousePosition(Popup popup)
void	showWindow(Window window, int animationDuration)
void	unregisterClientObject(ClientObject clientObject)

Methods inherited from class java.lang.Object

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

Field Details

onActivityStateChanged

public final Event<UiSessionActivityState> onActivityStateChanged

onDestroyed

public final Event<java.lang.Void> onDestroyed

executionDecorators

public final ExecutionDecoratorStack executionDecorators

Decorators around all executions inside this SessionContext. These will be invoked when the Thread is already bound to the SessionContext, so SessionContext.current() will return this instance.

Constructor Details

SessionContext

public SessionContext(QualifiedUiSessionId sessionId, ClientInfo clientInfo, javax.servlet.http.HttpSession httpSession, UiCommandExecutor commandExecutor, UxServerContext serverContext, org.teamapps.icons.api.IconTheme iconTheme, com.fasterxml.jackson.databind.ObjectMapper jacksonObjectMapper)

Method Details

current

public static SessionContext current()

currentOrNull

public static SessionContext currentOrNull()

setCustomMessageBundleProvider

public void setCustomMessageBundleProvider(java.util.function.Function<java.util.Locale,java.util.ResourceBundle> provider)

getLocale

public java.util.Locale getLocale()

getMessageBundle

public java.util.ResourceBundle getMessageBundle()

getLocalized

public java.lang.String getLocalized(java.lang.String key, java.lang.Object... parameters)

isActive

public boolean isActive()

handleActivityStateChangedInternal

public void handleActivityStateChangedInternal(boolean active)

isDestroyed

public boolean isDestroyed()

destroy

public void destroy()

handleSessionDestroyedInternal

public void handleSessionDestroyedInternal()

onDestroyed

public Event<java.lang.Void> onDestroyed()

queueCommand

public <RESULT> void queueCommand(org.teamapps.dto.UiCommand<RESULT> command, java.util.function.Consumer<RESULT> resultCallback)

queueCommand

public <RESULT> void queueCommand(org.teamapps.dto.UiCommand<RESULT> command)

getClientInfo

public ClientInfo getClientInfo()

getHttpSession

public javax.servlet.http.HttpSession getHttpSession()

flushCommands

@Deprecated public void flushCommands()

Deprecated.

no more needed. commands are sent as early as the client can handle them.

getClientBackPressureInfo

public ClientBackPressureInfo getClientBackPressureInfo()

getIconTheme

public org.teamapps.icons.api.IconTheme getIconTheme()

setIconTheme

public void setIconTheme(org.teamapps.icons.api.IconTheme theme)

createFileLink

public java.lang.String createFileLink(java.io.File file)

createResourceLink

public java.lang.String createResourceLink(Resource resource, java.lang.String uniqueIdentifier)

getBinaryResource

public Resource getBinaryResource(int resourceId)

getUploadedFileByUuid

public java.io.File getUploadedFileByUuid(java.lang.String uuid)

registerTemplate

public TemplateReference registerTemplate(java.lang.String id, Template template)

registerTemplates

public void registerTemplates(java.util.Map<java.lang.String,Template> templates)

getTemplate

public Template getTemplate(java.lang.String id)

runWithContext

public java.util.concurrent.CompletableFuture<java.lang.Void> runWithContext(java.lang.Runnable runnable)

runWithContext

public java.util.concurrent.CompletableFuture<java.lang.Void> runWithContext(java.lang.Runnable runnable, boolean forceEnqueue)

Parameters:

runnable -

forceEnqueue - No synchronous execution! Enqueue this at the end of this SessionContext's work queue.

Returns:

addExecutionDecorator

public void addExecutionDecorator(ExecutionDecorator decorator, boolean outer)

Adds a decorator that gets invoked whenever a Thread is bound to this SessionContext. The decorator will be called right after the Thread is bound to this SessionContext, so SessionContext.current() will return this instance.

Parameters:

decorator -

outer - Whether to add this decorator as outermost or innermost execution wrapper.

getConfiguration

public SessionConfiguration getConfiguration()

setConfiguration

public void setConfiguration(SessionConfiguration config)

showPopupAtCurrentMousePosition

public void showPopupAtCurrentMousePosition(Popup popup)

showPopup

public void showPopup(Popup popup)

getLanguageLocale

public java.util.Locale getLanguageLocale()

getTimeZone

public java.time.ZoneId getTimeZone()

resolveIcon

public java.lang.String resolveIcon(org.teamapps.icons.api.Icon icon)

registerClientObject

public void registerClientObject(ClientObject clientObject)

unregisterClientObject

public void unregisterClientObject(ClientObject clientObject)

getClientObject

public ClientObject getClientObject(java.lang.String clientObjectId)

createResourceLink

public java.lang.String createResourceLink(Resource resource)

showWindow

public void showWindow(Window window, int animationDuration)

downloadFile

public void downloadFile(java.lang.String fileUrl, java.lang.String downloadFileName)

registerBackgroundImage

public void registerBackgroundImage(java.lang.String id, java.lang.String image, java.lang.String blurredImage)

setBackgroundImage

public void setBackgroundImage(java.lang.String id, int animationDuration)

setBackgroundColor

public void setBackgroundColor(org.teamapps.common.format.Color color, int animationDuration)

exitFullScreen

public void exitFullScreen()

addRootComponent

public void addRootComponent(java.lang.String containerElementId, RootPanel rootPanel)

addClientToken

public void addClientToken(java.lang.String token)

removeClientToken

public void removeClientToken(java.lang.String token)

clearClientTokens

public void clearClientTokens()

showNotification

public void showNotification(Notification notification, NotificationPosition position, EntranceAnimation entranceAnimation, ExitAnimation exitAnimation)

showNotification

public void showNotification(Notification notification, NotificationPosition position)

showNotification

public void showNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption)

showNotification

public void showNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption, java.lang.String description)

showNotification

public void showNotification(org.teamapps.icons.api.Icon icon, java.lang.String caption, java.lang.String description, boolean dismissable, int displayTimeInMillis, boolean showProgress)