org.eclipse.scout.rt.client

Class AbstractClientSession

java.lang.Object

org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

org.eclipse.scout.rt.client.AbstractClientSession

All Implemented Interfaces:

IClientSession, org.eclipse.scout.rt.platform.reflect.IPropertyObserver, IExtensibleObject, ISession

public abstract class AbstractClientSession
extends org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver
implements IClientSession, IExtensibleObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractClientSession.LocalClientSessionExtension<OWNER extends AbstractClientSession> The extension delegating to the local methods.

Field Summary

Fields inherited from class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

propertySupport

Fields inherited from interface org.eclipse.scout.rt.client.IClientSession

PROP_LOCALE

Fields inherited from interface org.eclipse.scout.rt.shared.ISession

CURRENT

Constructor Summary

Constructors

Constructor and Description
AbstractClientSession(boolean autoInitConfig)

Method Summary

Modifier and Type	Method and Description
void	addListener(ISessionListener sessionListener)
protected void	cancelRunningJobs()
Object	computeDataIfAbsent(String key, Callable<?> producer)
protected IClientSessionExtension<? extends AbstractClientSession>	createLocalExtension()
protected void	execLoadSession() Initialize the properties of the client session.
protected void	execStoreSession() This method is called just before the session is stopped and can be overwritten to persist properties of the client session
protected void	fireSessionChangedEvent(SessionEvent event)
List<? extends IClientSessionExtension<? extends AbstractClientSession>>	getAllExtensions()
URI	getBrowserURI()
protected boolean	getConfiguredSingleThreadSession()
Object	getData(String key)
IDesktop	getDesktop()
IDesktop	getDesktopElseVirtualDesktop()
int	getExitCode()
<T extends IExtension<?>> T	getExtension(Class<T> c)
String	getId()
Locale	getLocale()
IMemoryPolicy	getMemoryPolicy() see IMemoryPolicy
org.eclipse.scout.rt.platform.job.IExecutionSemaphore	getModelJobSemaphore() Returns the one-permit IExecutionSemaphore to run model jobs of this session in sequence, meaning that only one model job is active at any given time for this session.
protected <T> T	getSharedContextVariable(String name, Class<T> type) Do not use this method directly.
Map<String,Object>	getSharedVariableMap()
Object	getStateLock() Monitor can be used to wait for changes of the states 'active' and 'loaded'
Subject	getSubject() Consumers can query for the Subject of a IClientSession
ScoutTexts	getTexts() Returns the ScoutTexts instance assigned to the type (class) of the current ClientSession.
UserAgent	getUserAgent()
String	getUserId() Returns the userId of the subject holding the current session
IDesktop	getVirtualDesktop()
protected void	inactivateSession()
protected void	initConfig()
protected void	initializeSharedVariables() Pings the server to get the initial shared variables.
protected void	initializeSharedVariables(long timeout, TimeUnit unit)
protected void	interceptInitConfig()
protected void	interceptLoadSession()
protected void	interceptStoreSession()
boolean	isActive()
boolean	isStopping()
void	removeListener(ISessionListener sessionListener)
void	replaceSharedVariableMapInternal(SharedVariableMap newMap) replace the shared variable map with a new version.
protected URI	resolveBrowserUri() Resolves the browser URI, or null if could not be resolved.
protected IMemoryPolicy	resolveMemoryPolicy() Returns the memory policy to be used.
void	setData(String key, Object value)
void	setDesktop(IDesktop desktop) Sets the desktop model associated with this client session.
void	setLocale(Locale locale) Sets the given Locale to the session and NlsLocale.CURRENT.
void	setMemoryPolicy(IMemoryPolicy memoryPolicy) see IMemoryPolicy
void	setSubject(Subject subject)
void	setUserAgent(UserAgent userAgent) Sets the given UserAgent to the session and UserAgent.CURRENT.
void	start(String sessionId)
void	stop() Close the session
void	stop(int exitCode)
String	toString()

Methods inherited from class org.eclipse.scout.rt.platform.reflect.AbstractPropertyObserver

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getSpecificPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.scout.rt.platform.reflect.IPropertyObserver

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Constructor Detail

AbstractClientSession

public AbstractClientSession(boolean autoInitConfig)

Method Detail

getAllExtensions

public final List<? extends IClientSessionExtension<? extends AbstractClientSession>> getAllExtensions()

Specified by:

getAllExtensions in interface IExtensibleObject

getExtension

public <T extends IExtension<?>> T getExtension(Class<T> c)

Specified by:

getExtension in interface IExtensibleObject

createLocalExtension

protected IClientSessionExtension<? extends AbstractClientSession> createLocalExtension()

interceptInitConfig

protected final void interceptInitConfig()

getConfiguredSingleThreadSession

protected boolean getConfiguredSingleThreadSession()

getId

public String getId()

Specified by:

getId in interface ISession

getUserId

public String getUserId()

Returns the userId of the subject holding the current session

Specified by:

getUserId in interface ISession

getTexts

public ScoutTexts getTexts()

Returns the ScoutTexts instance assigned to the type (class) of the current ClientSession.

Override this method to set the application specific texts implementation

Specified by:

getTexts in interface ISession

getLocale

public final Locale getLocale()

Specified by:

getLocale in interface IClientSession

Returns:

the session's Locale or null if not set.

setLocale

public final void setLocale(Locale locale)

Description copied from interface: IClientSession

Sets the given Locale to the session and NlsLocale.CURRENT.

Specified by:

setLocale in interface IClientSession

Parameters:

locale - Locale to be set.

getUserAgent

public UserAgent getUserAgent()

Specified by:

getUserAgent in interface IClientSession

Returns:

the session's UserAgent; is never null; contains information about the UI.

setUserAgent

public void setUserAgent(UserAgent userAgent)

Description copied from interface: IClientSession

Sets the given UserAgent to the session and UserAgent.CURRENT.

Specified by:

setUserAgent in interface IClientSession

Parameters:

userAgent - UserAgent to be set.

getBrowserURI

public URI getBrowserURI()

Specified by:

getBrowserURI in interface IClientSession

Returns:

the public URI in the browser which hosts this application (typically ending in /index.html or similar)

isActive

public boolean isActive()

Specified by:

isActive in interface ISession

getSharedVariableMap

public Map<String,Object> getSharedVariableMap()

Specified by:

getSharedVariableMap in interface ISession

getSharedContextVariable

protected <T> T getSharedContextVariable(String name,
                                         Class<T> type)

Do not use this method directly. Create specific (typed) methods instead to access shared variables. (like getUserId())

Returns the variables shared with the server. Shared variables are automatically updated on the client by client notifications when changed on the server.

getStateLock

public final Object getStateLock()

Description copied from interface: IClientSession

Monitor can be used to wait for changes of the states 'active' and 'loaded'

Specified by:

getStateLock in interface IClientSession

initConfig

protected void initConfig()

resolveBrowserUri

protected URI resolveBrowserUri()

Resolves the browser URI, or null if could not be resolved.

The default implementation looks in the current calling context for the URL. Typically, that URL is set only during session initialization.

See Also:

org.eclipse.scout.rt.ui.html.UiSession#createAndStartClientSession()

resolveMemoryPolicy

protected IMemoryPolicy resolveMemoryPolicy()

Returns the memory policy to be used.

replaceSharedVariableMapInternal

public void replaceSharedVariableMapInternal(SharedVariableMap newMap)

replace the shared variable map with a new version.

Specified by:

replaceSharedVariableMapInternal in interface IClientSession

Parameters:

newMap -

initializeSharedVariables

protected void initializeSharedVariables(long timeout,
                                         TimeUnit unit)

initializeSharedVariables

protected void initializeSharedVariables()

Pings the server to get the initial shared variables. Blocks until the initial version of the shared variables is available or the timeout is reached.

Throws:

org.eclipse.scout.rt.platform.exception.ProcessingException - if interrupted (and the variables are not initialized)

start

public void start(String sessionId)

Specified by:

start in interface ISession

execLoadSession

protected void execLoadSession()

Initialize the properties of the client session. This method is called in the process of the initialization right before the session is activated.

execStoreSession

protected void execStoreSession()

This method is called just before the session is stopped and can be overwritten to persist properties of the client session

getVirtualDesktop

public IDesktop getVirtualDesktop()

Specified by:

getVirtualDesktop in interface IClientSession

Returns:

a virtual desktop model assiciated with this client session

Before a desktop is set using IClientSession.setDesktop(IDesktop) this is a virtual desktop ONLY used to early register observers.
Once a desktop has been set, this is the same as calling IClientSession.getDesktop()

getDesktop

public IDesktop getDesktop()

Specified by:

getDesktop in interface IClientSession

Returns:

the desktop model associated with this client session

Desktop is available only after ISession.start(String) and

getDesktopElseVirtualDesktop

public IDesktop getDesktopElseVirtualDesktop()

Specified by:

getDesktopElseVirtualDesktop in interface IClientSession

Returns:

the IDesktop associated with this IClientSession, or a virtual IDesktop with limited functionality if not set yet.

setDesktop

public void setDesktop(IDesktop desktop)

Description copied from interface: IClientSession

Sets the desktop model associated with this client session.

Specified by:

setDesktop in interface IClientSession

stop

public void stop()

Close the session

Specified by:

stop in interface IClientSession

Specified by:

stop in interface ISession

stop

public void stop(int exitCode)

Specified by:

stop in interface IClientSession

cancelRunningJobs

protected void cancelRunningJobs()

inactivateSession

protected void inactivateSession()

isStopping

public boolean isStopping()

Specified by:

isStopping in interface IClientSession

Returns:

true if session shutdown is in progress (i.g. IClientSession.stop() was called). While shutting down, the session is still considered "active".

getExitCode

public int getExitCode()

Specified by:

getExitCode in interface IClientSession

getMemoryPolicy

public IMemoryPolicy getMemoryPolicy()

Description copied from interface: IClientSession

see IMemoryPolicy

Specified by:

getMemoryPolicy in interface IClientSession

setMemoryPolicy

public void setMemoryPolicy(IMemoryPolicy memoryPolicy)

Description copied from interface: IClientSession

see IMemoryPolicy

Specified by:

setMemoryPolicy in interface IClientSession

getSubject

public Subject getSubject()

Description copied from interface: IClientSession

Consumers can query for the Subject of a IClientSession

The IServiceTunnel used by IClientSession#getServiceTunnel() checks for the Subject under which the session is running and creates a WSSE security element.

The subject is set when this object is created from Subject.getSubject(java.security.AccessControlContext)

Specified by:

getSubject in interface IClientSession

setSubject

public void setSubject(Subject subject)

Specified by:

setSubject in interface IClientSession

setData

public void setData(String key,
                    Object value)

Specified by:

setData in interface ISession

computeDataIfAbsent

public Object computeDataIfAbsent(String key,
                                  Callable<?> producer)

Specified by:

computeDataIfAbsent in interface ISession

getData

public Object getData(String key)

Specified by:

getData in interface ISession

interceptStoreSession

protected final void interceptStoreSession()

interceptLoadSession

protected final void interceptLoadSession()

addListener

public void addListener(ISessionListener sessionListener)

Specified by:

addListener in interface ISession

removeListener

public void removeListener(ISessionListener sessionListener)

Specified by:

removeListener in interface ISession

getModelJobSemaphore

public org.eclipse.scout.rt.platform.job.IExecutionSemaphore getModelJobSemaphore()

Description copied from interface: IClientSession

Returns the one-permit IExecutionSemaphore to run model jobs of this session in sequence, meaning that only one model job is active at any given time for this session.

Specified by:

getModelJobSemaphore in interface IClientSession

fireSessionChangedEvent

protected void fireSessionChangedEvent(SessionEvent event)

toString

public String toString()

Overrides:

toString in class Object