org.eclipse.jetty.server.session

Class Session

java.lang.Object

org.eclipse.jetty.server.session.Session

All Implemented Interfaces:

javax.servlet.http.HttpSession, SessionHandler.SessionIf

Direct Known Subclasses:

AbstractSessionCache.PlaceHolderSession

public class Session
extends Object
implements SessionHandler.SessionIf

Session

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Session.SessionInactivityTimeout SessionInactivityTimeout
static class	Session.State State Validity states of a session

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_extendedId
protected SessionHandler	_handler
protected long	_requests
protected SessionData	_sessionData
static String	SESSION_CREATED_SECURE

Constructor Summary

Constructors

Constructor and Description
Session(SessionHandler handler, javax.servlet.http.HttpServletRequest request, SessionData data) Create a new session
Session(SessionHandler handler, SessionData data) Re-create an existing session

Method Summary

Modifier and Type	Method and Description
protected boolean	access(long time)
void	bindValue(String name, Object value) Bind value if value implements HttpSessionBindingListener (calls HttpSessionBindingListener.valueBound(HttpSessionBindingEvent))
protected void	callSessionAttributeListeners(String name, Object newValue, Object oldValue) Call binding and attribute listeners based on the new and old values of the attribute.
protected void	checkLocked()
protected void	checkValidForRead() asserts that the session is valid
protected void	checkValidForWrite() asserts that the session is valid
protected void	complete()
protected void	cookieSet()
void	didActivate() Call the activation listeners.
protected void	doInvalidate()
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
int	getAttributes()
String	getContextPath()
long	getCookieSetTime()
long	getCreationTime()
String	getExtendedId()
String	getId()
long	getLastAccessedTime()
int	getMaxInactiveInterval()
Set<String>	getNames()
long	getRequests() Should call this method with a lock held if you want to make decision on what to do with the session
javax.servlet.ServletContext	getServletContext()
Session	getSession()
javax.servlet.http.HttpSessionContext	getSessionContext()
protected SessionData	getSessionData()
SessionHandler	getSessionHandler()
Object	getValue(String name)
String[]	getValueNames() Deprecated. As of Version 2.2, this method is replaced by getAttributeNames()
String	getVHost()
void	invalidate() Called by users to invalidate a session, or called by the access method as a request enters the session if the session has expired, or called by manager as a result of scavenger expiring session
protected boolean	isExpiredAt(long time) Check to see if session has expired as at the time given.
boolean	isIdChanged()
protected boolean	isIdleLongerThan(int sec)
boolean	isNew()
boolean	isResident()
boolean	isValid()
Locker.Lock	lock() Grab the lock on the session
void	putValue(String name, Object value)
void	removeAttribute(String name)
void	removeValue(String name)
void	renewId(javax.servlet.http.HttpServletRequest request)
void	setAttribute(String name, Object value)
void	setExtendedId(String extendedId)
void	setIdChanged(boolean changed)
void	setMaxInactiveInterval(int secs)
void	setResident(boolean resident)
void	stopInactivityTimer()
void	unbindValue(String name, Object value) Unbind value if value implements HttpSessionBindingListener (calls HttpSessionBindingListener.valueUnbound(HttpSessionBindingEvent))
void	updateInactivityTimer() Set the inactivity timer to the smaller of the session maxInactivity (ie session-timeout from web.xml), or the inactive eviction time.
void	willPassivate() Call the passivation listeners.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SESSION_CREATED_SECURE

public static final String SESSION_CREATED_SECURE

See Also:

Constant Field Values

_sessionData

protected SessionData _sessionData

_handler

protected SessionHandler _handler

_extendedId

protected String _extendedId

_requests

protected long _requests

Constructor Detail

Session

public Session(SessionHandler handler,
               javax.servlet.http.HttpServletRequest request,
               SessionData data)

Create a new session

Parameters:

handler - TODO

request - the request the session should be based on

data - the session data

Session

public Session(SessionHandler handler,
               SessionData data)

Re-create an existing session

Parameters:

handler - TODO

data - the session data

Method Detail

getRequests

public long getRequests()

Should call this method with a lock held if you want to make decision on what to do with the session

Returns:

the number of active requests for this session

setExtendedId

public void setExtendedId(String extendedId)

cookieSet

protected void cookieSet()

access

protected boolean access(long time)

complete

protected void complete()

isExpiredAt

protected boolean isExpiredAt(long time)

Check to see if session has expired as at the time given.

Parameters:

time - the time in milliseconds

Returns:

true if expired

isIdleLongerThan

protected boolean isIdleLongerThan(int sec)

callSessionAttributeListeners

protected void callSessionAttributeListeners(String name,
                                             Object newValue,
                                             Object oldValue)

Call binding and attribute listeners based on the new and old values of the attribute.

Parameters:

name - name of the attribute

newValue - new value of the attribute

oldValue - previous value of the attribute

unbindValue

public void unbindValue(String name,
                        Object value)

Unbind value if value implements HttpSessionBindingListener (calls HttpSessionBindingListener.valueUnbound(HttpSessionBindingEvent))

Parameters:

name - the name with which the object is bound or unbound

value - the bound value

bindValue

public void bindValue(String name,
                      Object value)

Bind value if value implements HttpSessionBindingListener (calls HttpSessionBindingListener.valueBound(HttpSessionBindingEvent))

Parameters:

name - the name with which the object is bound or unbound

value - the bound value

didActivate

public void didActivate()

Call the activation listeners. This must be called holding the _lock.

willPassivate

public void willPassivate()

Call the passivation listeners. This must be called holding the _lock

isValid

public boolean isValid()

getCookieSetTime

public long getCookieSetTime()

getCreationTime

public long getCreationTime()
                     throws IllegalStateException

Specified by:

getCreationTime in interface javax.servlet.http.HttpSession

Throws:

IllegalStateException

getId

public String getId()

Specified by:

getId in interface javax.servlet.http.HttpSession

See Also:

HttpSession.getId()

getExtendedId

public String getExtendedId()

getContextPath

public String getContextPath()

getVHost

public String getVHost()

getLastAccessedTime

public long getLastAccessedTime()

Specified by:

getLastAccessedTime in interface javax.servlet.http.HttpSession

See Also:

HttpSession.getLastAccessedTime()

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface javax.servlet.http.HttpSession

See Also:

HttpSession.getServletContext()

setMaxInactiveInterval

public void setMaxInactiveInterval(int secs)

Specified by:

setMaxInactiveInterval in interface javax.servlet.http.HttpSession

See Also:

HttpSession.setMaxInactiveInterval(int)

updateInactivityTimer

public void updateInactivityTimer()

Set the inactivity timer to the smaller of the session maxInactivity (ie session-timeout from web.xml), or the inactive eviction time.

stopInactivityTimer

public void stopInactivityTimer()

getMaxInactiveInterval

public int getMaxInactiveInterval()

Specified by:

getMaxInactiveInterval in interface javax.servlet.http.HttpSession

See Also:

HttpSession.getMaxInactiveInterval()

getSessionContext

public javax.servlet.http.HttpSessionContext getSessionContext()

Specified by:

getSessionContext in interface javax.servlet.http.HttpSession

See Also:

HttpSession.getSessionContext()

getSessionHandler

public SessionHandler getSessionHandler()

checkValidForWrite

protected void checkValidForWrite()
                           throws IllegalStateException

asserts that the session is valid

Throws:

IllegalStateException - if the session is invalid

checkValidForRead

protected void checkValidForRead()
                          throws IllegalStateException

asserts that the session is valid

Throws:

IllegalStateException - if the session is invalid

checkLocked

protected void checkLocked()
                    throws IllegalStateException

Throws:

IllegalStateException

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface javax.servlet.http.HttpSession

See Also:

HttpSession.getAttribute(java.lang.String)

getValue

public Object getValue(String name)

Specified by:

getValue in interface javax.servlet.http.HttpSession

See Also:

HttpSession.getValue(java.lang.String)

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.http.HttpSession

See Also:

HttpSession.getAttributeNames()

getAttributes

public int getAttributes()

getNames

public Set<String> getNames()

getValueNames

@Deprecated
public String[] getValueNames()
                                   throws IllegalStateException

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

Specified by:

getValueNames in interface javax.servlet.http.HttpSession

Throws:

IllegalStateException

setAttribute

public void setAttribute(String name,
                         Object value)

Specified by:

setAttribute in interface javax.servlet.http.HttpSession

See Also:

HttpSession.setAttribute(java.lang.String, java.lang.Object)

putValue

public void putValue(String name,
                     Object value)

Specified by:

putValue in interface javax.servlet.http.HttpSession

See Also:

HttpSession.putValue(java.lang.String, java.lang.Object)

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface javax.servlet.http.HttpSession

See Also:

HttpSession.removeAttribute(java.lang.String)

removeValue

public void removeValue(String name)

Specified by:

removeValue in interface javax.servlet.http.HttpSession

See Also:

HttpSession.removeValue(java.lang.String)

renewId

public void renewId(javax.servlet.http.HttpServletRequest request)

invalidate

public void invalidate()

Called by users to invalidate a session, or called by the access method as a request enters the session if the session has expired, or called by manager as a result of scavenger expiring session

Specified by:

invalidate in interface javax.servlet.http.HttpSession

See Also:

HttpSession.invalidate()

lock

public Locker.Lock lock()

Grab the lock on the session

Returns:

the lock

doInvalidate

protected void doInvalidate()
                     throws IllegalStateException

Throws:

IllegalStateException

isNew

public boolean isNew()
              throws IllegalStateException

Specified by:

isNew in interface javax.servlet.http.HttpSession

Throws:

IllegalStateException

setIdChanged

public void setIdChanged(boolean changed)

isIdChanged

public boolean isIdChanged()

getSession

public Session getSession()

Specified by:

getSession in interface SessionHandler.SessionIf

getSessionData

protected SessionData getSessionData()

setResident

public void setResident(boolean resident)

isResident

public boolean isResident()