org.directwebremoting.impl
Class DefaultScriptSession

java.lang.Object
  org.directwebremoting.impl.DefaultScriptSession

All Implemented Interfaces:

RealScriptSession, ScriptSession

public class DefaultScriptSession
extends java.lang.Object
implements RealScriptSession

An implementation of ScriptSession and RealScriptSession.

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]

Nested Class Summary

Nested classes/interfaces inherited from interface org.directwebremoting.extend.RealScriptSession

RealScriptSession.Script

Method Summary

void	addRunnable(java.lang.Runnable runnable) Add a Runnable to the waiting list for execution.
void	addScript(ScriptBuffer script) Add a script to the list waiting for remote execution.
void	clearSleeper(Sleeper sleeper) Remove Sleeper.
void	confirmScripts(long confirmedScriptIndex) Confirms that the client has received all scripts up to and including the supplied index so that script data may be purged.
boolean	equals(java.lang.Object obj)
java.lang.Object	getAttribute(java.lang.String name) Returns the object bound with the specified name in this ScriptSession, or null if no object is bound under the name.
java.util.Iterator<java.lang.String>	getAttributeNames() Returns an Enumeration of String objects containing the names of all the objects bound to this ScriptSession.
long	getCreationTime() Returns the time when this ScriptSession was created, measured in milliseconds since midnight January 1, 1970 GMT.
java.lang.String	getHttpSessionId() If this ScriptSession's browser session also has a HttpSession then this method gives access to its id (typically corresponding to the JSESSIONID cookie).
java.lang.String	getId() Returns a string containing the unique identifier assigned to this ScriptSession.
long	getLastAccessedTime() Returns the last time the client sent a request associated with this ScriptSession, as the number of milliseconds since 1/1/1970 GMT, and marked by the time the container received the request.
java.lang.String	getPage() What page is this script session attached to? The page does not include server information, but does include everything from the host/port onwards, including the query parameters depending on the configured PageNormalizer, which by default removes them.
RealScriptSession.Script	getScript(long scriptIndex) Get queued script from the supplied index.
int	hashCode()
void	invalidate() Invalidates this ScriptSession then unbinds any objects bound to it.
boolean	isInvalidated() Checks to see if this ScriptSession has been invalidated.
void	removeAttribute(java.lang.String name) Removes the object bound with the specified name from this ScriptSession.
void	setAttribute(java.lang.String name, java.lang.Object value) Binds an object to this ScriptSession, using the name specified.
void	setConnectionValidationTimeout(int connectionValidationTimeout) Set the time to wait for client to poll when asking for connection validation.
void	setHttpSessionId(java.lang.String httpSessionId) Set a new HttpSession id for the ScriptSession
void	setPage(java.lang.String page) Set a new page for the ScriptSession (in case of HTML pushState)
void	setSleeper(Sleeper sleeper) While a Marshaller is processing a request it can register a Sleeper with the ScriptSession to say - "tell me when there is new data"
java.lang.String	toString()
void	updateLastAccessedTime() Called whenever a browser accesses this ScriptSession to ensure that the session does not timeout before it should.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Description copied from interface: ScriptSession

Returns the object bound with the specified name in this ScriptSession, or null if no object is bound under the name.

Specified by:

getAttribute in interface ScriptSession

Parameters:

name - a string specifying the name of the object

Returns:

the object with the specified name

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Description copied from interface: ScriptSession

Binds an object to this ScriptSession, using the name specified. If an object of the same name is already bound to the ScriptSession, the object is replaced.

After this method executes, and if the new object implements ScriptSessionBindingListener, the container calls ScriptSessionBindingListener.valueBound(org.directwebremoting.event.ScriptSessionBindingEvent).

If an object was already bound to this ScriptSession of this name that implements ScriptSessionBindingListener, its ScriptSessionBindingListener.valueUnbound(org.directwebremoting.event.ScriptSessionBindingEvent) method is called.

If the value passed in is null, this has the same effect as calling ScriptSession.removeAttribute(java.lang.String).

Specified by:

setAttribute in interface ScriptSession

Parameters:

name - the name to which the object is bound; cannot be null

value - the object to be bound

removeAttribute

public void removeAttribute(java.lang.String name)

Description copied from interface: ScriptSession

Removes the object bound with the specified name from this ScriptSession. If the ScriptSession does not have an object bound with the specified name, this method does nothing.

After this method executes, and if the object implements ScriptSessionBindingListener, the container calls ScriptSessionBindingListener.valueUnbound(org.directwebremoting.event.ScriptSessionBindingEvent).

Specified by:

removeAttribute in interface ScriptSession

Parameters:

name - the name of the object to remove from this ScriptSession

getAttributeNames

public java.util.Iterator<java.lang.String> getAttributeNames()

Description copied from interface: ScriptSession

Returns an Enumeration of String objects containing the names of all the objects bound to this ScriptSession.

Specified by:

getAttributeNames in interface ScriptSession

Returns:

an Iterator of Strings, specifying the names of all the objects bound to this ScriptSession

invalidate

public void invalidate()

Description copied from interface: ScriptSession

Invalidates this ScriptSession then unbinds any objects bound to it.

Specified by:

invalidate in interface ScriptSession

isInvalidated

public boolean isInvalidated()

Description copied from interface: ScriptSession

Checks to see if this ScriptSession has been invalidated.

There is no similar method on HttpSession because it is assumed that you do not store HttpSessions from one request to another, so all sessions that you have access to will always be either valid, or you have just invalidated it yourself so you wont need to ask. This method makes up for the change that now ScriptSessions are accessible from outside the normal scope.

Specified by:

isInvalidated in interface ScriptSession

Returns:

true if the ScriptSession has been invalidated

getId

public java.lang.String getId()

Description copied from interface: ScriptSession

Returns a string containing the unique identifier assigned to this ScriptSession. The identifier is assigned by DWR.

Specified by:

getId in interface ScriptSession

Returns:

a string specifying the identifier assigned to this ScriptSession

getCreationTime

public long getCreationTime()

Description copied from interface: ScriptSession

Returns the time when this ScriptSession was created, measured in milliseconds since midnight January 1, 1970 GMT.

Specified by:

getCreationTime in interface ScriptSession

Returns:

when was this ScriptSession created, in milliseconds since 1/1/1970 GMT

getLastAccessedTime

public long getLastAccessedTime()

Description copied from interface: ScriptSession

Returns the last time the client sent a request associated with this ScriptSession, as the number of milliseconds since 1/1/1970 GMT, and marked by the time the container received the request.

Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.

Specified by:

getLastAccessedTime in interface ScriptSession

Returns:

when was this ScriptSession last accessed, in milliseconds since 1/1/1970 GMT

addScript

public void addScript(ScriptBuffer script)

Description copied from interface: ScriptSession

Add a script to the list waiting for remote execution.

Specified by:

addScript in interface ScriptSession

Parameters:

script - The script to execute

addRunnable

public void addRunnable(java.lang.Runnable runnable)

Description copied from interface: ScriptSession

Add a Runnable to the waiting list for execution. A new poll request will be triggered and the runnable will be executed at the beginning of it. The WebContext may be used to access request details from within the Runnable.

Specified by:

addRunnable in interface ScriptSession

setSleeper

public void setSleeper(Sleeper sleeper)

Description copied from interface: RealScriptSession

While a Marshaller is processing a request it can register a Sleeper with the ScriptSession to say - "tell me when there is new data"

Specified by:

setSleeper in interface RealScriptSession

clearSleeper

public void clearSleeper(Sleeper sleeper)

Description copied from interface: RealScriptSession

Remove Sleeper.

Specified by:

clearSleeper in interface RealScriptSession

getScript

public RealScriptSession.Script getScript(long scriptIndex)

Description copied from interface: RealScriptSession

Get queued script from the supplied index.

Specified by:

getScript in interface RealScriptSession

Parameters:

scriptIndex - index

Returns:

a Script instance or null if nothing in queue

confirmScripts

public void confirmScripts(long confirmedScriptIndex)

Description copied from interface: RealScriptSession

Confirms that the client has received all scripts up to and including the supplied index so that script data may be purged.

Specified by:

confirmScripts in interface RealScriptSession

Parameters:

confirmedScriptIndex - last index that can be purged

setPage

public void setPage(java.lang.String page)

Description copied from interface: RealScriptSession

Set a new page for the ScriptSession (in case of HTML pushState)

Specified by:

setPage in interface RealScriptSession

getPage

public java.lang.String getPage()

Description copied from interface: ScriptSession

What page is this script session attached to? The page does not include server information, but does include everything from the host/port onwards, including the query parameters depending on the configured PageNormalizer, which by default removes them.

Specified by:

getPage in interface ScriptSession

Returns:

The page that this script session is viewing

setHttpSessionId

public void setHttpSessionId(java.lang.String httpSessionId)

Description copied from interface: RealScriptSession

Set a new HttpSession id for the ScriptSession

Specified by:

setHttpSessionId in interface RealScriptSession

getHttpSessionId

public java.lang.String getHttpSessionId()

Description copied from interface: ScriptSession

If this ScriptSession's browser session also has a HttpSession then this method gives access to its id (typically corresponding to the JSESSIONID cookie).

Specified by:

getHttpSessionId in interface ScriptSession

Returns:

the id from an active associated HttpSession if any, otherwise null

updateLastAccessedTime

public void updateLastAccessedTime()

Description copied from interface: RealScriptSession

Called whenever a browser accesses this ScriptSession to ensure that the session does not timeout before it should.

Specified by:

updateLastAccessedTime in interface RealScriptSession

setConnectionValidationTimeout

public void setConnectionValidationTimeout(int connectionValidationTimeout)

Set the time to wait for client to poll when asking for connection validation.

Parameters:

connectionValidationTimeout -

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object