org.eclipse.jetty.server.session
Class AbstractSession

java.lang.Object
  extended by org.eclipse.jetty.server.session.AbstractSession
All Implemented Interfaces:
HttpSession, AbstractSessionManager.SessionIf
Direct Known Subclasses:
HashedSession, JDBCSessionManager.Session

public abstract class AbstractSession
extends Object
implements AbstractSessionManager.SessionIf

Implements HttpSession from the javax.servlet package.


Field Summary
protected  Map<String,Object> _jdbcAttributes
           
 
Constructor Summary
protected AbstractSession(AbstractSessionManager abstractSessionManager, HttpServletRequest request)
           
protected AbstractSession(AbstractSessionManager abstractSessionManager, long created, long accessed, String clusterId)
           
 
Method Summary
protected  boolean access(long time)
           
 void bindValue(String name, Object value)
          If value implements HttpSessionBindingListener, call valueBound()
protected  void checkValid()
          asserts that the session is valid
 void clearAttributes()
           
protected  void complete()
           
protected  void cookieSet()
           
 void didActivate()
           
protected  Object doGet(String name)
           
protected  void doInvalidate()
           
protected  Object doPutOrRemove(String name, Object value)
           
 long getAccessed()
           
 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<String> getAttributeNames()
          Returns an Enumeration of String objects containing the names of all the objects bound to this session.
 int getAttributes()
           
 String getClusterId()
           
 long getCookieSetTime()
           
 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.
 Set<String> getNames()
           
 String getNodeId()
           
 int getRequests()
           
 ServletContext getServletContext()
          Returns the ServletContext to which this session belongs.
 AbstractSession getSession()
           
 HttpSessionContext getSessionContext()
          Deprecated. 
 Object getValue(String name)
          Deprecated. As of Version 2.2, this method is replaced by getAttribute(java.lang.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 isIdChanged()
           
 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()
           
 void putValue(String name, Object value)
          Deprecated. As of Version 2.2, this method is replaced by setAttribute(java.lang.String, java.lang.Object)
 void removeAttribute(String name)
          Removes the object bound with the specified name from this session.
 void removeValue(String name)
          Deprecated. As of Version 2.2, this method is replaced by removeAttribute(java.lang.String)
 void setAttribute(String name, Object value)
          Binds an object to this session, using the name specified.
 void setIdChanged(boolean changed)
           
 void setMaxInactiveInterval(int secs)
          Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
 void setRequests(int requests)
           
protected  void timeout()
           
 String toString()
           
 void unbindValue(String name, Object value)
          If value implements HttpSessionBindingListener, call valueUnbound()
 void willPassivate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_jdbcAttributes

protected final Map<String,Object> _jdbcAttributes
Constructor Detail

AbstractSession

protected AbstractSession(AbstractSessionManager abstractSessionManager,
                          HttpServletRequest request)

AbstractSession

protected AbstractSession(AbstractSessionManager abstractSessionManager,
                          long created,
                          long accessed,
                          String clusterId)
Method Detail

checkValid

protected void checkValid()
                   throws IllegalStateException
asserts that the session is valid

Throws:
IllegalStateException

getSession

public AbstractSession getSession()
Specified by:
getSession in interface AbstractSessionManager.SessionIf

getAccessed

public long getAccessed()

getAttribute

public Object getAttribute(String name)
Description copied from interface: HttpSession
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

getAttributes

public int getAttributes()

getAttributeNames

public Enumeration<String> getAttributeNames()
Description copied from interface: HttpSession
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

getNames

public Set<String> getNames()

getCookieSetTime

public long getCookieSetTime()

getCreationTime

public long getCreationTime()
                     throws IllegalStateException
Description copied from interface: HttpSession
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
Throws:
IllegalStateException - if this method is called on an invalidated session

getId

public String getId()
             throws IllegalStateException
Description copied from interface: HttpSession
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
Throws:
IllegalStateException

getNodeId

public String getNodeId()

getClusterId

public String getClusterId()

getLastAccessedTime

public long getLastAccessedTime()
                         throws IllegalStateException
Description copied from interface: HttpSession
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
Throws:
IllegalStateException - if this method is called on an invalidated session

getMaxInactiveInterval

public int getMaxInactiveInterval()
Description copied from interface: HttpSession
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()
Description copied from interface: HttpSession
Returns the ServletContext to which this session belongs.

Specified by:
getServletContext in interface HttpSession
Returns:
The ServletContext object for the web application

getSessionContext

@Deprecated
public HttpSessionContext getSessionContext()
                                     throws IllegalStateException
Deprecated. 

Specified by:
getSessionContext in interface HttpSession
Throws:
IllegalStateException

getValue

@Deprecated
public Object getValue(String name)
                throws IllegalStateException
Deprecated. As of Version 2.2, this method is replaced by getAttribute(java.lang.String)

Specified by:
getValue in interface HttpSession
Parameters:
name - a string specifying the name of the object
Returns:
the object with the specified name
Throws:
IllegalStateException - if this method is called on an invalidated session

getValueNames

@Deprecated
public String[] getValueNames()
                       throws IllegalStateException
Deprecated. As of Version 2.2, this method is replaced by getAttributeNames()

Specified by:
getValueNames in interface HttpSession
Returns:
an array of String objects specifying the names of all the objects bound to this session
Throws:
IllegalStateException - if this method is called on an invalidated session

access

protected boolean access(long time)

complete

protected void complete()

timeout

protected void timeout()
                throws IllegalStateException
Throws:
IllegalStateException

invalidate

public void invalidate()
                throws IllegalStateException
Description copied from interface: HttpSession
Invalidates this session then unbinds any objects bound to it.

Specified by:
invalidate in interface HttpSession
Throws:
IllegalStateException - if this method is called on an already invalidated session

doInvalidate

protected void doInvalidate()
                     throws IllegalStateException
Throws:
IllegalStateException

clearAttributes

public void clearAttributes()

isIdChanged

public boolean isIdChanged()

isNew

public boolean isNew()
              throws IllegalStateException
Description copied from interface: HttpSession
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
Throws:
IllegalStateException - if this method is called on an already invalidated session

putValue

@Deprecated
public void putValue(String name,
                                Object value)
              throws IllegalStateException
Deprecated. As of Version 2.2, this method is replaced by setAttribute(java.lang.String, java.lang.Object)

Specified by:
putValue in interface HttpSession
Parameters:
name - the name to which the object is bound; cannot be null
value - the object to be bound; cannot be null
Throws:
IllegalStateException - if this method is called on an invalidated session

removeAttribute

public void removeAttribute(String name)
Description copied from interface: HttpSession
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

@Deprecated
public void removeValue(String name)
                 throws IllegalStateException
Deprecated. As of Version 2.2, this method is replaced by removeAttribute(java.lang.String)

Specified by:
removeValue in interface HttpSession
Parameters:
name - the name of the object to remove from this session
Throws:
IllegalStateException - if this method is called on an invalidated session

doPutOrRemove

protected Object doPutOrRemove(String name,
                               Object value)

doGet

protected Object doGet(String name)

setAttribute

public void setAttribute(String name,
                         Object value)
Description copied from interface: HttpSession
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

setIdChanged

public void setIdChanged(boolean changed)

setMaxInactiveInterval

public void setMaxInactiveInterval(int secs)
Description copied from interface: HttpSession
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:
secs - An integer specifying the number of seconds

toString

public String toString()
Overrides:
toString in class Object

bindValue

public void bindValue(String name,
                      Object value)
If value implements HttpSessionBindingListener, call valueBound()


isValid

public boolean isValid()

cookieSet

protected void cookieSet()

getRequests

public int getRequests()

setRequests

public void setRequests(int requests)

unbindValue

public void unbindValue(String name,
                        Object value)
If value implements HttpSessionBindingListener, call valueUnbound()


willPassivate

public void willPassivate()

didActivate

public void didActivate()


Copyright © 1995-2011 Mort Bay Consulting. All Rights Reserved.