org.directwebremoting.impl
Class DefaultScriptSessionManager

java.lang.Object
  org.directwebremoting.impl.DefaultScriptSessionManager

All Implemented Interfaces:

InitializingBean, ScriptSessionManager, UninitializingBean

public class DefaultScriptSessionManager
extends java.lang.Object
implements ScriptSessionManager, InitializingBean, UninitializingBean

A default implementation of ScriptSessionManager.

You should note that DefaultScriptSession and DefaultScriptSessionManager make calls to each other and you should take care not to break any constraints in inheriting from these classes.

Author:

Joe Walker [joe at getahead dot ltd dot uk]

Field Summary

Fields inherited from interface org.directwebremoting.extend.ScriptSessionManager

DEFAULT_TIMEOUT_MILLIS

Constructor Summary

DefaultScriptSessionManager()

Method Summary

void	addScriptSessionListener(ScriptSessionListener li) Maintain the list of ScriptSessionListeners
void	afterContainerSetup(Container container) This method allows the bean instance to perform initialization only possible when all bean properties have been set
void	destroy() Called when Container.destroy() is called which usually happens when the DWR servlet is destroyed.
java.util.Collection<ScriptSession>	getAllScriptSessions() Get a list of all the currently known ScriptSessions by id.
java.lang.String	getInitCode() Some implementations of ScriptSessionManager need to add custom code into engine.js to register ScriptSessions with the server.
RealScriptSession	getOrCreateScriptSession(java.lang.String sentScriptId, java.lang.String page, javax.servlet.http.HttpSession httpSession) For a given script session id, return the existing ScriptSession object or create a new if needed.
ScriptSession	getScriptSessionById(java.lang.String scriptSessionId) Lookup the ScriptSession corresponding to a ScriptSession id.
java.util.Collection<ScriptSession>	getScriptSessionsByHttpSessionId(java.lang.String httpSessionId) Lookup all the windows associated with a given browser
long	getScriptSessionTimeout() Accessor for the time (in milliseconds) when unused ScriptSessions will expire
void	removeScriptSessionListener(ScriptSessionListener li) Maintain the list of ScriptSessionListeners
void	setConverterManager(ConverterManager converterManager)
void	setJsonOutput(boolean jsonOutput)
void	setPageNormalizer(PageNormalizer pageNormalizer) How we turn pages into the canonical form.
void	setScheduledThreadPoolExecutor(java.util.concurrent.ScheduledThreadPoolExecutor executor) How often do we check for script sessions that need timing out
void	setScriptSessionCheckTime(long scriptSessionCheckTime) How often do we check for script sessions that need timing out
void	setScriptSessionTimeout(long scriptSessionTimeout)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultScriptSessionManager

public DefaultScriptSessionManager()

Method Detail

afterContainerSetup

public void afterContainerSetup(Container container)

Description copied from interface: InitializingBean

This method allows the bean instance to perform initialization only possible when all bean properties have been set

Specified by:

afterContainerSetup in interface InitializingBean

Parameters:

container - The container that is doing the initialization

destroy

public void destroy()

Description copied from interface: UninitializingBean

Called when Container.destroy() is called which usually happens when the DWR servlet is destroyed.

Specified by:

destroy in interface UninitializingBean

getOrCreateScriptSession

public RealScriptSession getOrCreateScriptSession(java.lang.String sentScriptId,
                                                  java.lang.String page,
                                                  javax.servlet.http.HttpSession httpSession)

Description copied from interface: ScriptSessionManager

For a given script session id, return the existing ScriptSession object or create a new if needed.

Specified by:

getOrCreateScriptSession in interface ScriptSessionManager

Parameters:

sentScriptId - The id to get a ScriptSession object for

page - The URL including 'http://', up to (but not including) '?' or '#' (or null if not known)

httpSession - The session to associate the ScriptSession with (if any)

Returns:

A ScriptSession to match the ID.

getScriptSessionById

public ScriptSession getScriptSessionById(java.lang.String scriptSessionId)

Description copied from interface: ScriptSessionManager

Lookup the ScriptSession corresponding to a ScriptSession id.

Specified by:

getScriptSessionById in interface ScriptSessionManager

Parameters:

scriptSessionId - The id to lookup

Returns:

The corresponding ScriptSession object, or null.

getScriptSessionsByHttpSessionId

public java.util.Collection<ScriptSession> getScriptSessionsByHttpSessionId(java.lang.String httpSessionId)

Description copied from interface: ScriptSessionManager

Lookup all the windows associated with a given browser

Specified by:

getScriptSessionsByHttpSessionId in interface ScriptSessionManager

Parameters:

httpSessionId - The browser id to lookup

Returns:

A list of script sessions for each open window

getAllScriptSessions

public java.util.Collection<ScriptSession> getAllScriptSessions()

Description copied from interface: ScriptSessionManager

Get a list of all the currently known ScriptSessions by id. Note that the list of known sessions is continually changing so it is possible that the list will be out of date by the time it is used. For this reason you should check that getScriptSession(String id) returns something non null.

Specified by:

getAllScriptSessions in interface ScriptSessionManager

Returns:

An iterator over the currently known sessions, by id

addScriptSessionListener

public void addScriptSessionListener(ScriptSessionListener li)

Description copied from interface: ScriptSessionManager

Maintain the list of ScriptSessionListeners

Specified by:

addScriptSessionListener in interface ScriptSessionManager

Parameters:

li - the ScriptSessionListener to add

removeScriptSessionListener

public void removeScriptSessionListener(ScriptSessionListener li)

Description copied from interface: ScriptSessionManager

Maintain the list of ScriptSessionListeners

Specified by:

removeScriptSessionListener in interface ScriptSessionManager

Parameters:

li - the ScriptSessionListener to remove

getInitCode

public java.lang.String getInitCode()

Description copied from interface: ScriptSessionManager

Some implementations of ScriptSessionManager need to add custom code into engine.js to register ScriptSessions with the server.

Specified by:

getInitCode in interface ScriptSessionManager

getScriptSessionTimeout

public long getScriptSessionTimeout()

Description copied from interface: ScriptSessionManager

Accessor for the time (in milliseconds) when unused ScriptSessions will expire

Specified by:

getScriptSessionTimeout in interface ScriptSessionManager

Returns:

the scriptSessionTimeout

setScriptSessionTimeout

public void setScriptSessionTimeout(long scriptSessionTimeout)

setPageNormalizer

public void setPageNormalizer(PageNormalizer pageNormalizer)

How we turn pages into the canonical form.

Parameters:

pageNormalizer - The new PageNormalizer

setScriptSessionCheckTime

public void setScriptSessionCheckTime(long scriptSessionCheckTime)

How often do we check for script sessions that need timing out

setScheduledThreadPoolExecutor

public void setScheduledThreadPoolExecutor(java.util.concurrent.ScheduledThreadPoolExecutor executor)

How often do we check for script sessions that need timing out

setConverterManager

public void setConverterManager(ConverterManager converterManager)

setJsonOutput

public void setJsonOutput(boolean jsonOutput)

Parameters:

jsonOutput - Are we outputting in JSON mode?