org.apache.tapestry.web
Interface WebSession

All Superinterfaces:
AttributeHolder, Describable
All Known Implementing Classes:
ServletWebSession

public interface WebSession
extends AttributeHolder, Describable

Primarily concerned with maintaining server-side state as attributes.

Since:
4.0
Author:
Howard M. Lewis Ship

Method Summary
 java.lang.String getId()
          Returns a unique string identifier used to identify the session.
 void invalidate()
          Invalidates this session then unbinds any objects bound to it.
 boolean isNew()
          Returns true if the client does not yet know about the session or if the client chooses not to join the session.
 
Methods inherited from interface org.apache.tapestry.web.AttributeHolder
getAttribute, getAttributeNames, setAttribute
 
Methods inherited from interface org.apache.tapestry.describe.Describable
describeTo
 

Method Detail

getId

public java.lang.String getId()
Returns a unique string identifier used to identify the session. This value is provided by the container, and is typically incorporated into URLs, or stored as a HTTP cookie.

See Also:
WebResponse.encodeURL(String).

isNew

public boolean isNew()
Returns true if the client does not yet know about the session or if the client chooses not to join the session.


invalidate

public void invalidate()
Invalidates this session then unbinds any objects bound to it.

Throws:
java.lang.IllegalStateException - if the session is already invalidated.