Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.mortbay.jetty.servlet

Class AbstractSessionManager.Session

Enclosing Class:
AbstractSessionManager
Implemented Interfaces:
HttpSession, SessionManager.Session
Known Direct Subclasses:
HashSessionManager.Session
public abstract class AbstractSessionManager.Session
extends java.lang.Object
implements SessionManager.Session

Constructor Summary

Session(HttpServletRequest request)

Method Summary

void
access()
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.
Enumeration
getAttributeNames()
Returns an Enumeration of String objects containing the names of all the objects bound to this session.
long
getCreationTime()
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
String
getId()
Returns a string containing the unique identifier assigned to this session.
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, and marked by the time the container received the request.
int
getMaxInactiveInterval()
Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.
ServletContext
getServletContext()
Returns the ServletContext to which this session belongs.
HttpSessionContext
getSessionContext()
Deprecated.
Object
getValue(String name)
Deprecated. As of Version 2.2, this method is replaced by getAttribute(String)
String[]
getValueNames()
Deprecated. As of Version 2.2, this method is replaced by getAttributeNames()
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.
boolean
isValid()
protected abstract Map
newAttributeMap()
void
putValue(java.lang.String name, java.lang.Object value)
Deprecated. As of Version 2.2, this method is replaced by setAttribute(String,Object)
void
removeAttribute(String name)
Removes the object bound with the specified name from this session.
void
removeValue(java.lang.String name)
Deprecated. As of Version 2.2, this method is replaced by removeAttribute(String)
void
setAttribute(String name, Object value)
Binds an object to this session, using the name specified.
void
setMaxInactiveInterval(int secs)
Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.

Constructor Details

Session

protected Session(HttpServletRequest request)

Method Details

access

public void access()
Specified by:
access in interface SessionManager.Session

getAttribute

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.
Specified by:
getAttribute in interface HttpSession
Parameters:
name - a string specifying the name of the object
Returns:
the object with the specified name

getAttributeNames

public Enumeration getAttributeNames()
Returns an Enumeration of String objects containing the names of all the objects bound to this session.
Specified by:
getAttributeNames in interface HttpSession
Returns:
an Enumeration of String objects specifying the names of all the objects bound to this session

getCreationTime

public long getCreationTime()
            throws IllegalStateException
Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
Specified by:
getCreationTime in interface HttpSession
Returns:
a long specifying when this session was created, expressed in milliseconds since 1/1/1970 GMT

getId

public String getId()
            throws IllegalStateException
Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the servlet container and is implementation dependent.
Specified by:
getId in interface HttpSession
Returns:
a string specifying the identifier assigned to this session

getLastAccessedTime

public long getLastAccessedTime()
            throws IllegalStateException
Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 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 HttpSession
Returns:
a long representing the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT

getMaxInactiveInterval

public int getMaxInactiveInterval()
Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses. After this interval, the servlet 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.
Specified by:
getMaxInactiveInterval in interface HttpSession
Returns:
an integer specifying the number of seconds this session remains open between client requests
See Also:
HttpSession.setMaxInactiveInterval(int)

getServletContext

public ServletContext getServletContext()
Returns the ServletContext to which this session belongs.
Specified by:
getServletContext in interface HttpSession
Returns:
The ServletContext object for the web application
Since:
Servlet 2.3

getSessionContext

public HttpSessionContext getSessionContext()
            throws IllegalStateException

Deprecated.

Specified by:
getSessionContext in interface HttpSession

getValue

public Object getValue(String name)
            throws IllegalStateException

Deprecated. As of Version 2.2, this method is replaced by getAttribute(String)

Specified by:
getValue in interface HttpSession

getValueNames

public String[] getValueNames()
            throws IllegalStateException

Deprecated. As of Version 2.2, this method is replaced by getAttributeNames()

Specified by:
getValueNames in interface HttpSession

invalidate

public void invalidate()
            throws IllegalStateException
Invalidates this session then unbinds any objects bound to it.
Specified by:
invalidate in interface HttpSession

isNew

public boolean isNew()
            throws IllegalStateException
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.
Specified by:
isNew in interface HttpSession
Returns:
true if the server has created a session, but the client has not yet joined

isValid

public boolean isValid()
Specified by:
isValid in interface SessionManager.Session

newAttributeMap

protected abstract Map newAttributeMap()

putValue

public void putValue(java.lang.String name,
                     java.lang.Object value)
            throws IllegalStateException

Deprecated. As of Version 2.2, this method is replaced by setAttribute(String,Object)

removeAttribute

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.

After this method executes, and if the object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueUnbound. The container then notifies any HttpSessionAttributeListeners in the web application.

Specified by:
removeAttribute in interface HttpSession
Parameters:
name - the name of the object to remove from this session

removeValue

public void removeValue(java.lang.String name)
            throws IllegalStateException

Deprecated. As of Version 2.2, this method is replaced by removeAttribute(String)

setAttribute

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.

After this method executes, and if the new object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueBound. The container then notifies any HttpSessionAttributeListeners in the web application.

If an object was already bound to this session of this name that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called.

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

Specified by:
setAttribute in interface HttpSession
Parameters:
name - the name to which the object is bound; cannot be null
value - the object to be bound

setMaxInactiveInterval

public void setMaxInactiveInterval(int secs)
Specifies the time, in seconds, between client requests before the servlet container will invalidate this session. A negative time indicates the session should never timeout.
Specified by:
setMaxInactiveInterval in interface HttpSession
Parameters:

Overview Package Tree Index Deprecated About
Copyright © 2004 Mortbay Consulting Pty. Ltd. All Rights Reserved.