| org.directwebremoting.extend.ScriptSessionManager
All known Subclasses: org.directwebremoting.impl.DefaultScriptSessionManager,
| ScriptSessionManager | | public interface ScriptSessionManager (Code) | | A ScriptSessionManager looks after a number of sessions (keyed using a
Javascript variable)
author:
Joe Walker [joe at getahead dot ltd dot uk] |
| Field Summary | |
| final static long | DEFAULT_TIMEOUT_MILLIS
The default length of time a session can go unused before it
automatically becomes invalid and is recycled. |
| DEFAULT_TIMEOUT_MILLIS | | final static long DEFAULT_TIMEOUT_MILLIS(Code) | | The default length of time a session can go unused before it
automatically becomes invalid and is recycled.
The default is 5mins
|
| createScriptSession | | RealScriptSession createScriptSession(String url, String httpSessionId)(Code) | | When a new client page-loads, we create a script session.
Parameters:
url - The URL including 'http://', up to (but not including) '?' or '#'
Parameters:
httpSessionId - The session ID (or null if not known) The new script session id |
| getAllScriptSessions | | Collection<ScriptSession> getAllScriptSessions()(Code) | | 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.
An iterator over the currently known sessions, by id |
| getScriptSession | | RealScriptSession getScriptSession(String id, String url, String httpSessionId)(Code) | | For a given script session id, return the related ScriptSession object
or null if the id is not known.
Parameters:
id - The id to get a ScriptSession object for
Parameters:
url - The URL including 'http://', up to (but not including) '?' or '#' (or null if not known)
Parameters:
httpSessionId - The session ID (or null if not known) A ScriptSession to match the ID, or null if a match is not found. |
| getScriptSessionTimeout | | long getScriptSessionTimeout()(Code) | | Accessor for the time (in milliseconds) when unused ScriptSessions will expire
the scriptSessionTimeout |
| getScriptSessionsByPage | | Collection<ScriptSession> getScriptSessionsByPage(String url)(Code) | | For a given script session id, either create a new ScriptSession object
or retrieve an existing one if one exists.
Parameters:
url - The URL including 'http://', up to (but not including) '?' or '#' A ScriptSession. |
|
|