All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.apache.jserv.JServSession

java.lang.Object
   |
   +----org.apache.jserv.JServSession

public class JServSession
extends Object
implements HttpSession
This is the object that encapsulates a session.

Author:
Francis J. Lacoste

Constructor Index

 o JServSession(String, JServServletManager)
Creates a new session.

Method Index

 o access()
Tells the session that it has been accessed
 o getCreationTime()
Returns the time at which this session representation was created, in milliseconds since midnight, January 1, 1970 UTC.
 o getId()
Returns the identifier assigned to this session.
 o getLastAccessedTime()
Returns the last time the client sent a request carrying the identifier assigned to the session.
 o getSessionContext()
Returns the context in which this session is bound.
 o getValue(String)
Returns the object bound to the given name in the session's application layer data.
 o getValueNames()
Returns an array of the names of all the application layer data objects bound into the session.
 o invalidate()
Causes this representation of the session to be invalidated and removed from its context.
 o isNew()
A session is considered to be "new" if it has been created by the server, but the client has not yet acknowledged joining the session.
 o isValid()
Has the session been invalidated.
 o putValue(String, Object)
Binds the specified object into the session's application layer data with the given name.
 o removeValue(String)
Removes the object bound to the given name in the session's application layer data.

Constructors

 o JServSession
 public JServSession(String id,
                     JServServletManager context)
Creates a new session.

Parameters:
id - The id of the session.
context - The context of the session.

Methods

 o getId
 public synchronized String getId()
Returns the identifier assigned to this session. An HttpSession's identifier is a unique string that is created and maintained by HttpSessionContext.

Returns:
the identifier assigned to this session
Throws: IllegalStateException
if an attempt is made to access session data after the session has been invalidated
 o getSessionContext
 public synchronized HttpSessionContext getSessionContext()
Returns the context in which this session is bound.

Returns:
the name of the context in which this session is bound
Throws: IllegalStateException
if an attempt is made to access session data after the session has been invalidated
 o getCreationTime
 public synchronized long getCreationTime()
Returns the time at which this session representation was created, in milliseconds since midnight, January 1, 1970 UTC.

Returns:
the time when the session was created.
Throws: IllegalStateException
if an attempt is made to access session data after the session has been invalidated
 o getLastAccessedTime
 public synchronized long getLastAccessedTime()
Returns the last time the client sent a request carrying the identifier assigned to the session. Time is expressed as milliseconds since midnight, January 1, 1970 UTC. Application level operations, such as getting or setting a value associated with the session, does not affect the access time.

This information is particularly useful in session management policies. For example,

Returns:
the last time the client sent a request carrying the identifier assigned to the session.
Throws: IllegalStateException
if an attempt is made to access session data after the session has been invalidated
 o invalidate
 public synchronized void invalidate()
Causes this representation of the session to be invalidated and removed from its context.

Throws: IllegalStateException
if an attempt is made to access session data after the session has been invalidated
 o putValue
 public synchronized void putValue(String name,
                                   Object value)
Binds the specified object into the session's application layer data with the given name. Any existing binding with the same name is replaced. New (or existing) values that implement the HttpSessionBindingListener interface will call its valueBound() method.

Parameters:
name - the name to which the data object will be bound. This parameter cannot be null.
value - the data object to be bound. This parameter cannot be null.
Throws: IllegalStateException
if an attempt is made to access session data after the session has been invalidated
 o getValue
 public synchronized Object getValue(String name)
Returns the object bound to the given name in the session's application layer data. Returns null if there is no such binding.

Parameters:
name - the name of the binding to find
Returns:
the value bound to that name, or null if the binding does not exist.
Throws: IllegalStateException
if an attempt is made to access session data after the session has been invalidated
 o removeValue
 public synchronized void removeValue(String name)
Removes the object bound to the given name in the session's application layer data. Does nothing if there is no object bound to the given name. The value that implements the HttpSessionBindingListener interface will call its valueUnbound() method.

Parameters:
name - the name of the object to remove
Throws: IllegalStateException
if an attempt is made to access session data after the session has been invalidated
 o getValueNames
 public synchronized String[] getValueNames()
Returns an array of the names of all the application layer data objects bound into the session. For example, if you want to delete all of the data objects bound into the session, use this method to obtain their names.

Returns:
an array containing the names of all of the application layer data objects bound into the session
Throws: IllegalStateException
if an attempt is made to access session data after the session has been invalidated
 o isNew
 public synchronized boolean isNew()
A session is considered to be "new" if it has been created by the server, but the client has not yet acknowledged joining the session. For example, if the server supported only cookie-based sessions and the client had completely disabled the use of cookies, then calls to HttpServletRequest.getSession() would always return "new" sessions.

Returns:
true if the session has been created by the server but the client has not yet acknowledged joining the session; false otherwise
 o isValid
 public boolean isValid()
Has the session been invalidated.

 o access
 public synchronized void access()
Tells the session that it has been accessed


All Packages  Class Hierarchy  This Package  Previous  Next  Index