Package org.teamapps.ux.session

Class SimpleSessionContext

java.lang.Object

org.teamapps.ux.session.SimpleSessionContext

All Implemented Interfaces:

LockableSessionContext, SessionContext

public class SimpleSessionContext
extends java.lang.Object
implements LockableSessionContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleSessionContext.UTF8Control

Constructor Summary

Constructors

Constructor	Description
SimpleSessionContext(QualifiedUiSessionId sessionId, ClientInfo clientInfo, CommandDispatcher commandDispatcher, UxServerContext serverContext, org.teamapps.icons.api.IconTheme iconTheme, com.fasterxml.jackson.databind.ObjectMapper jacksonObjectMapper)

Method Summary

Modifier and Type	Method	Description
java.lang.String	createFileLink(java.io.File file)
java.lang.String	createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length, java.lang.String resourceName)
java.lang.String	createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier, long length, java.lang.String resourceName, java.lang.String uniqueIdentifier)
void	destroy()
void	flushCommands()
Resource	getBinaryResource(int resourceId)
ClientInfo	getClientInfo()
SessionConfiguration	getConfiguration()
org.teamapps.icons.api.IconTheme	getIconTheme()
long	getLastClientEventTimestamp()
java.util.Locale	getLocale()
java.lang.String	getLocalized(java.lang.String key, java.lang.Object... parameters)
java.util.ResourceBundle	getMessageBundle()
SessionStore	getSessionStore()
Template	getTemplate(java.lang.String id)
java.io.File	getUploadedFileByUuid(java.lang.String uuid)
boolean	isOpen()
void	lock(long timeoutMillis)
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)
TemplateReference	registerTemplate(java.lang.String id, Template template)
void	registerTemplates(java.util.Map<java.lang.String,Template> templates)
void	runWithContext(java.lang.Runnable runnable)	Does the following: Releases the current SessionContext (A) lock (if present) Acquires the lock for this SessionContext (B) Sets this SessionContext (B) as the current context (CurrentSessionContext). Executes the specified Runnable. Sets back the last SessionContext (A) as current context. Releases the lock for this SessionContext (B) Reacquires the lock for the last (A)
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	setLastClientEventTimestamp(long timestamp)
void	unlock()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.session.SessionContext

addClientToken, addRootComponent, clearClientTokens, closeWindow, closeWindow, createResourceLink, downloadFile, exitFullScreen, getComponent, getLanguageLocale, getTimeZone, registerBackgroundImage, registerComponent, removeClientToken, resolveIcon, setBackgroundColor, setBackgroundImage, showNotification, showNotification, showNotification, showWindow, unregisterComponent

Constructor Detail

SimpleSessionContext

public SimpleSessionContext(QualifiedUiSessionId sessionId,
                            ClientInfo clientInfo,
                            CommandDispatcher commandDispatcher,
                            UxServerContext serverContext,
                            org.teamapps.icons.api.IconTheme iconTheme,
                            com.fasterxml.jackson.databind.ObjectMapper jacksonObjectMapper)

Method Detail

setCustomMessageBundleProvider

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

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface SessionContext

getMessageBundle

public java.util.ResourceBundle getMessageBundle()

Specified by:

getMessageBundle in interface SessionContext

getLocalized

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

Specified by:

getLocalized in interface SessionContext

getLastClientEventTimestamp

public long getLastClientEventTimestamp()

Specified by:

getLastClientEventTimestamp in interface SessionContext

setLastClientEventTimestamp

public void setLastClientEventTimestamp(long timestamp)

Specified by:

setLastClientEventTimestamp in interface SessionContext

isOpen

public boolean isOpen()

Specified by:

isOpen in interface SessionContext

destroy

public void destroy()

Specified by:

destroy in interface SessionContext

onDestroyed

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

Specified by:

onDestroyed in interface SessionContext

queueCommand

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

Specified by:

queueCommand in interface SessionContext

queueCommand

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

Specified by:

queueCommand in interface SessionContext

getClientInfo

public ClientInfo getClientInfo()

Specified by:

getClientInfo in interface SessionContext

flushCommands

public void flushCommands()

Specified by:

flushCommands in interface SessionContext

getIconTheme

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

Specified by:

getIconTheme in interface SessionContext

setIconTheme

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

Specified by:

setIconTheme in interface SessionContext

getSessionStore

public SessionStore getSessionStore()

Specified by:

getSessionStore in interface SessionContext

createFileLink

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

Specified by:

createFileLink in interface SessionContext

createResourceLink

public java.lang.String createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier,
                                           long length,
                                           java.lang.String resourceName)

Specified by:

createResourceLink in interface SessionContext

createResourceLink

public java.lang.String createResourceLink(java.util.function.Supplier<java.io.InputStream> inputStreamSupplier,
                                           long length,
                                           java.lang.String resourceName,
                                           java.lang.String uniqueIdentifier)

Specified by:

createResourceLink in interface SessionContext

getBinaryResource

public Resource getBinaryResource(int resourceId)

Specified by:

getBinaryResource in interface SessionContext

getUploadedFileByUuid

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

Specified by:

getUploadedFileByUuid in interface SessionContext

registerTemplate

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

Specified by:

registerTemplate in interface SessionContext

registerTemplates

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

Specified by:

registerTemplates in interface SessionContext

getTemplate

public Template getTemplate(java.lang.String id)

Specified by:

getTemplate in interface SessionContext

lock

public void lock(long timeoutMillis)

Specified by:

lock in interface LockableSessionContext

unlock

public void unlock()

Specified by:

unlock in interface LockableSessionContext

runWithContext

public void runWithContext(java.lang.Runnable runnable)

Does the following:

1. Releases the current SessionContext (A) lock (if present)
2. Acquires the lock for this SessionContext (B)
3. Sets this SessionContext (B) as the current context (CurrentSessionContext).
4. Executes the specified Runnable.
5. Sets back the last SessionContext (A) as current context.
6. Releases the lock for this SessionContext (B)
7. Reacquires the lock for the last (A)

Specified by:

runWithContext in interface SessionContext

Parameters:

runnable - the code to be executed.

getConfiguration

public SessionConfiguration getConfiguration()

Specified by:

getConfiguration in interface SessionContext

setConfiguration

public void setConfiguration(SessionConfiguration config)

Specified by:

setConfiguration in interface SessionContext