Save This Page
Home » cocoon-2.1.11-src » org.apache » cocoon » environment » http » [javadoc | source]
org.apache.cocoon.environment.http
public final class: HttpSession [javadoc | source]
java.lang.Object
   org.apache.cocoon.environment.http.HttpSession

All Implemented Interfaces:
    Session

Provides a way to identify a user across more than one page request or visit to a Web site and to store information about that user.

Cocoon uses this interface to create a session between a client and the "cocoon server". The session persists for a specified time period, across more than one connection or page request from the user. A session usually corresponds to one user, who may visit a site many times. The server can maintain a session in many ways such as using cookies or rewriting URLs.

This interface allows Cocoon to

Session information is scoped only to the current context (Context), so information stored in one context will not be directly visible in another.

Field Summary
 HttpSession wrappedSession     
Constructor:
 public HttpSession(HttpSession session) 
    Construct a new session from an HttpSession
Method from org.apache.cocoon.environment.http.HttpSession Summary:
getAttribute,   getAttributeNames,   getCreationTime,   getId,   getLastAccessedTime,   getMaxInactiveInterval,   invalidate,   isNew,   removeAttribute,   setAttribute,   setMaxInactiveInterval
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cocoon.environment.http.HttpSession Detail:
 public Object getAttribute(String name) 
    Returns the object bound with the specified name in this session, or null if no object is bound under the name.
 public Enumeration getAttributeNames() 
    Returns an Enumeration of String objects containing the names of all the objects bound to this session.
 public long getCreationTime() 
    Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
 public String getId() 
    Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the context container and is implementation dependent.
 public long getLastAccessedTime() 
    Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT.

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

 public int getMaxInactiveInterval() 
    Returns the maximum time interval, in seconds, that the context container will keep this session open between client accesses. After this interval, the context container will invalidate the session. The maximum time interval can be set with the setMaxInactiveInterval method. A negative time indicates the session should never timeout.
 public  void invalidate() 
    Invalidates this session to it.
 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. For example, if the server used only cookie-based sessions, and the client had disabled the use of cookies, then a session would be new on each request.
 public  void removeAttribute(String name) 
    Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.
 public  void setAttribute(String name,
    Object value) 
    Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.
 public  void setMaxInactiveInterval(int interval) 
    Specifies the time, in seconds, between client requests before the contextcontainer will invalidate this session. A negative time indicates the session should never timeout.