Package org.teamapps.ux.session

Class SessionContext

java.lang.Object

org.teamapps.ux.session.SessionContext

public class SessionContext
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final ExecutionDecoratorStack	executionDecorators	Decorators around all executions inside this SessionContext.
final Event<UiSessionActivityState>	onActivityStateChanged
final Event<UiSessionClosingReason>	onDestroyed
final Event<KeyboardEvent>	onGlobalKeyEventOccurred
final Event<NavigationStateChangeEvent>	onNavigationStateChange

Constructor Summary

Constructors

Constructor	Description
SessionContext(UiSession uiSession, CloseableExecutor sessionExecutor, ClientInfo clientInfo, SessionConfiguration sessionConfiguration, jakarta.servlet.http.HttpSession httpSession, UxServerContext serverContext, SessionIconProvider iconProvider, String navigationPathPrefix, jakarta.ws.rs.ext.ParamConverterProvider navigationParamConverterProvider)

Method Summary

Modifier and Type	Method	Description
void	addClientToken(String token)
void	addExecutionDecorator(ExecutionDecorator decorator, boolean outer)	Adds a decorator that gets invoked whenever a Thread is bound to this SessionContext.
void	addIconBundle(IconBundle iconBundle)
void	addRootComponent(String containerElementSelector, Component component)
RootPanel	addRootPanel()
RootPanel	addRootPanel(String containerElementSelector)
void	addRootPanel(String containerElementSelector, Component rootPanel)
void	changeNavigationHistoryState(String pathWithQueryParams, boolean fireEvent, NavigationHistoryOperation operation)
void	clearClientTokens()
void	clearExecutionDecorators()	Removes all decorators.
static Window	createDefaultSessionMessageWindow(String title, String message, String refreshButtonCaption, String cancelButtonCaption)
String	createFileLink(File file)
String	createResourceLink(Resource resource)
String	createResourceLink(Resource resource, String uniqueIdentifier)
static SessionContext	current()
static SessionContext	currentOrNull()
void	destroy()
void	download(File file, String downloadFileName)
void	download(String url, String downloadFileName)
void	download(Resource resource)
void	download(Resource resource, String downloadFileName)
void	exitFullScreen()
UiSessionListener	getAsUiSessionListenerInternal()
Router	getBaseRouter()
Resource	getBinaryResource(int resourceId)
ClientBackPressureInfo	getClientBackPressureInfo()
ClientInfo	getClientInfo()
ClientObject	getClientObject(String clientObjectId)
SessionConfiguration	getConfiguration()
Location	getCurrentLocation()
jakarta.servlet.http.HttpSession	getHttpSession()
Icon<?,?>	getIcon(String key)
SessionIconProvider	getIconProvider()
Locale	getLocale()
String	getLocalized(String key, Object... parameters)
String	getName()
Router	getRouter(String pathPrefix)
RoutingMode	getRoutingMode()
jakarta.ws.rs.ext.ParamConverterProvider	getRoutingParamConverterProvider()
String	getSessionId()
UiSessionState	getState()
Template	getTemplate(String id)
ZoneId	getTimeZone()
TranslationProvider	getTranslationProvider()
UiSessionStats	getUiSessionStats()
com.ibm.icu.util.ULocale	getULocale()
File	getUploadedFileByUuid(String uuid)
void	goToUrl(String url, boolean blankPage)
void	handleStaticEvent(UiEvent event)
boolean	isActive()
boolean	isDestroyed()
void	navigateBack(int steps)
void	navigateForward(int steps)
Event<UiSessionClosingReason>	onDestroyed()	Same as onDestroyed but mockable.
void	pushNavigationHistoryState(String pathWithQueryParams, boolean fireEvent)	Pushes a new entry (URL) to the browser's navigation history without reloading the site.
void	queueCommand(UiCommand<?> command)
<RESULT> void	queueCommand(UiCommand<RESULT> command, Consumer<RESULT> resultCallback)
void	registerBackgroundImage(String id, String image, String blurredImage)
void	registerClientObject(ClientObject clientObject)
TemplateReference	registerTemplate(String id, Template template)
void	registerTemplates(Map<String,Template> templates)
void	removeClientToken(String token)
void	removeExecutionDecorator(ExecutionDecorator decorator)	Removes the specified execution decorator.
void	replaceNavigationHistoryState(String pathWithQueryParams, boolean fireEvent)	Same as pushNavigationHistoryState(String, boolean), except that it replaces the current browser history entry (URL).
CompletableFuture<WakeLock>	requestWakeLock()
String	resolveIcon(Icon icon)
void	route()
CompletableFuture<Void>	runWithContext(Runnable runnable)
CompletableFuture<Void>	runWithContext(Runnable runnable, boolean forceEnqueue)
<R> CompletableFuture<R>	runWithContext(Callable<R> runnable)
<R> CompletableFuture<R>	runWithContext(Callable<R> callable, boolean forceEnqueue)
void	setBackgroundColor(Color color, int animationDuration)
void	setBackgroundImage(String id, int animationDuration)
void	setConfiguration(SessionConfiguration config)
<I extends Icon<I, S>, S> void	setDefaultStyleForIconClass(Class<I> iconClass, S defaultStyle)
void	setFavicon(String url)
void	setFavicon(Icon<?,?> icon)
void	setFavicon(Resource resource)
void	setGlobalKeyEventsEnabled(boolean unmodified, boolean modifiedWithAltKey, boolean modifiedWithCtrlKey, boolean modifiedWithMetaKey, boolean includeRepeats, boolean keyDown, boolean keyUp)
void	setLocale(Locale locale)
void	setName(String name)
void	setRoutingMode(RoutingMode routingMode)
void	setSessionErrorWindow(Window sessionErrorWindow)
void	setSessionExpiredWindow(Window sessionExpiredWindow)
void	setSessionTerminatedWindow(Window sessionTerminatedWindow)
void	setTitle(String title)
void	setTranslationProvider(TranslationProvider translationProvider)
void	setULocale(com.ibm.icu.util.ULocale locale)
void	showDefaultBackground(int animationDuration)
void	showNotification(Icon icon, String caption)
void	showNotification(Icon icon, String caption, String description)
void	showNotification(Icon icon, String caption, 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)
String	toString()
void	unregisterClientObject(ClientObject clientObject)
void	updateNavigationHistoryState()

Methods inherited from class java.lang.Object

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

Field Details

onGlobalKeyEventOccurred

public final Event<KeyboardEvent> onGlobalKeyEventOccurred

onActivityStateChanged

public final Event<UiSessionActivityState> onActivityStateChanged

onDestroyed

public final Event<UiSessionClosingReason> 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.

onNavigationStateChange

public final Event<NavigationStateChangeEvent> onNavigationStateChange

Constructor Details

SessionContext

public SessionContext(UiSession uiSession,
 CloseableExecutor sessionExecutor,
 ClientInfo clientInfo,
 SessionConfiguration sessionConfiguration,
 jakarta.servlet.http.HttpSession httpSession,
 UxServerContext serverContext,
 SessionIconProvider iconProvider,
 String navigationPathPrefix,
 jakarta.ws.rs.ext.ParamConverterProvider navigationParamConverterProvider)

Method Details

getCurrentLocation

public Location getCurrentLocation()

navigateBack

public void navigateBack(int steps)

navigateForward

public void navigateForward(int steps)

getBaseRouter

public Router getBaseRouter()

getRouter

public Router getRouter(String pathPrefix)

updateNavigationHistoryState

public void updateNavigationHistoryState()

pushNavigationHistoryState

public void pushNavigationHistoryState(String pathWithQueryParams,
 boolean fireEvent)

Pushes a new entry (URL) to the browser's navigation history without reloading the site. See JavaScript API.

This method may or may not fire an onNavigationStateChange event, depending on the value of the fireEvent parameter. Both cases are useful:

• When the user does some action that changes the state of the UI that needs to be reflected in the URL (say changing a table filter parameter) the corresponding change will most likely already have been applied to the UI. So in such a case it does not make sense to fire the event.
• In the case that the user clicks on a LinkButton (or similar action) which will navigate to some completely different parts of the UI, it makes sense that the event is triggered, so the routing to that UI can happen.

Note that the onNavigationStateChange event will not be fired asynchronously since it will be triggered by the client (browser!) in order to guarantee the correct sequence of events. For example, if the user presses a navigation button at the same time as this method is invoked, which one was first needs to be consistent on the client and server side.

Parameters:

pathWithQueryParams - May also be a complete URL, but this is not recommended, since the origin needs to stay the same.

fireEvent - Indicates whether an onNavigationStateChange event should be fired as a reaction of this invocation.

replaceNavigationHistoryState

public void replaceNavigationHistoryState(String pathWithQueryParams,
 boolean fireEvent)

Same as pushNavigationHistoryState(String, boolean), except that it replaces the current browser history entry (URL). See JavaScript API.

See Also:

• pushNavigationHistoryState(String, boolean)

changeNavigationHistoryState

public void changeNavigationHistoryState(String pathWithQueryParams,
 boolean fireEvent,
 NavigationHistoryOperation operation)

See Also:

• pushNavigationHistoryState(String, boolean)

current

public static SessionContext current()

currentOrNull

public static SessionContext currentOrNull()

setTranslationProvider

public void setTranslationProvider(TranslationProvider translationProvider)

getTranslationProvider

public TranslationProvider getTranslationProvider()

addIconBundle

public void addIconBundle(IconBundle iconBundle)

getIcon

public Icon<?,?> getIcon(String key)

getULocale

public com.ibm.icu.util.ULocale getULocale()

getLocale

public Locale getLocale()

setLocale

public void setLocale(Locale locale)

setULocale

public void setULocale(com.ibm.icu.util.ULocale locale)

getLocalized

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

isActive

public boolean isActive()

getState

public UiSessionState getState()

isDestroyed

public boolean isDestroyed()

destroy

public void destroy()

queueCommand

public <RESULT> void queueCommand(UiCommand<RESULT> command,
 Consumer<RESULT> resultCallback)

queueCommand

public void queueCommand(UiCommand<?> command)

getClientInfo

public ClientInfo getClientInfo()

getHttpSession

public jakarta.servlet.http.HttpSession getHttpSession()

getClientBackPressureInfo

public ClientBackPressureInfo getClientBackPressureInfo()

createFileLink

public String createFileLink(File file)

createResourceLink

public String createResourceLink(Resource resource,
 String uniqueIdentifier)

getBinaryResource

public Resource getBinaryResource(int resourceId)

getUploadedFileByUuid

public File getUploadedFileByUuid(String uuid)

registerTemplate

public TemplateReference registerTemplate(String id,
 Template template)

registerTemplates

public void registerTemplates(Map<String,Template> templates)

getTemplate

public Template getTemplate(String id)

runWithContext

public CompletableFuture<Void> runWithContext(Runnable runnable)

runWithContext

public CompletableFuture<Void> runWithContext(Runnable runnable,
 boolean forceEnqueue)

Parameters:

runnable -

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

runWithContext

public <R> CompletableFuture<R> runWithContext(Callable<R> runnable)

runWithContext

public <R> CompletableFuture<R> runWithContext(Callable<R> callable,
 boolean forceEnqueue)

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.

removeExecutionDecorator

public void removeExecutionDecorator(ExecutionDecorator decorator)

Removes the specified execution decorator.

clearExecutionDecorators

public void clearExecutionDecorators()

Removes all decorators.

getConfiguration

public SessionConfiguration getConfiguration()

setConfiguration

public void setConfiguration(SessionConfiguration config)

showPopupAtCurrentMousePosition

public void showPopupAtCurrentMousePosition(Popup popup)

showPopup

public void showPopup(Popup popup)

getTimeZone

public ZoneId getTimeZone()

getIconProvider

public SessionIconProvider getIconProvider()

setDefaultStyleForIconClass

public <I extends Icon<I,
S>,
S> void setDefaultStyleForIconClass(Class<I> iconClass,
 S defaultStyle)

resolveIcon

public String resolveIcon(Icon icon)

registerClientObject

public void registerClientObject(ClientObject clientObject)

unregisterClientObject

public void unregisterClientObject(ClientObject clientObject)

getClientObject

public ClientObject getClientObject(String clientObjectId)

createResourceLink

public String createResourceLink(Resource resource)

showWindow

public void showWindow(Window window,
 int animationDuration)

download

public void download(Resource resource)

download

public void download(Resource resource,
 String downloadFileName)

download

public void download(File file,
 String downloadFileName)

download

public void download(String url,
 String downloadFileName)

registerBackgroundImage

public void registerBackgroundImage(String id,
 String image,
 String blurredImage)

setBackgroundImage

public void setBackgroundImage(String id,
 int animationDuration)

showDefaultBackground

public void showDefaultBackground(int animationDuration)

setBackgroundColor

public void setBackgroundColor(Color color,
 int animationDuration)

exitFullScreen

public void exitFullScreen()

addRootComponent

public void addRootComponent(String containerElementSelector,
 Component component)

addRootPanel

public void addRootPanel(String containerElementSelector,
 Component rootPanel)

addRootPanel

public RootPanel addRootPanel(String containerElementSelector)

addRootPanel

public RootPanel addRootPanel()

addClientToken

public void addClientToken(String token)

removeClientToken

public void removeClientToken(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(Icon icon,
 String caption)

showNotification

public void showNotification(Icon icon,
 String caption,
 String description)

showNotification

public void showNotification(Icon icon,
 String caption,
 String description,
 boolean dismissable,
 int displayTimeInMillis,
 boolean showProgress)

setSessionExpiredWindow

public void setSessionExpiredWindow(Window sessionExpiredWindow)

setSessionErrorWindow

public void setSessionErrorWindow(Window sessionErrorWindow)

setSessionTerminatedWindow

public void setSessionTerminatedWindow(Window sessionTerminatedWindow)

createDefaultSessionMessageWindow

public static Window createDefaultSessionMessageWindow(String title,
 String message,
 String refreshButtonCaption,
 String cancelButtonCaption)

requestWakeLock

public CompletableFuture<WakeLock> requestWakeLock()

goToUrl

public void goToUrl(String url,
 boolean blankPage)

setFavicon

public void setFavicon(Icon<?,?> icon)

setFavicon

public void setFavicon(Resource resource)

setFavicon

public void setFavicon(String url)

setTitle

public void setTitle(String title)

setGlobalKeyEventsEnabled

public void setGlobalKeyEventsEnabled(boolean unmodified,
 boolean modifiedWithAltKey,
 boolean modifiedWithCtrlKey,
 boolean modifiedWithMetaKey,
 boolean includeRepeats,
 boolean keyDown,
 boolean keyUp)

getSessionId

public String getSessionId()

handleStaticEvent

public void handleStaticEvent(UiEvent event)

route

public void route()

getAsUiSessionListenerInternal

public UiSessionListener getAsUiSessionListenerInternal()

setName

public void setName(String name)

getName

public String getName()

getRoutingParamConverterProvider

public jakarta.ws.rs.ext.ParamConverterProvider getRoutingParamConverterProvider()

getUiSessionStats

public UiSessionStats getUiSessionStats()

toString

public String toString()

Overrides:

toString in class Object

getRoutingMode

public RoutingMode getRoutingMode()

setRoutingMode

public void setRoutingMode(RoutingMode routingMode)

onDestroyed

public Event<UiSessionClosingReason> onDestroyed()

Same as onDestroyed but mockable.