org.eclipse.jetty.server.session

Class AbstractSession

java.lang.Object

org.eclipse.jetty.server.session.AbstractSession

All Implemented Interfaces:

HttpSession, AbstractSessionManager.SessionIf

Direct Known Subclasses:

MemSession

public abstract class AbstractSession
extends Object
implements AbstractSessionManager.SessionIf

Implements HttpSession from the javax.servlet package.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SESSION_CREATED_SECURE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSession(AbstractSessionManager abstractSessionManager, HttpServletRequest request)
protected	AbstractSession(AbstractSessionManager abstractSessionManager, long created, long accessed, String clusterId)

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 Object	changeAttribute(String name, Object value) Either set (perhaps replace) or remove the value of the attribute in the session.
protected boolean	checkExpiry(long time) Check to see if session has expired as at the time given.
protected void	checkValid() asserts that the session is valid
abstract void	clearAttributes()
protected void	complete()
protected void	cookieSet()
void	didActivate()
abstract Object	doGet(String name)
abstract Enumeration<String>	doGetAttributeNames()
protected void	doInvalidate()
abstract Object	doPutOrRemove(String name, Object value)
long	getAccessed()
Object	getAttribute(String name)
abstract Map<String,Object>	getAttributeMap()
Enumeration<String>	getAttributeNames()
abstract int	getAttributes()
String	getClusterId()
long	getCookieSetTime()
long	getCreationTime()
String	getId()
long	getLastAccessedTime()
int	getMaxInactiveInterval()
abstract Set<String>	getNames()
String	getNodeId()
int	getRequests()
ServletContext	getServletContext()
AbstractSession	getSession()
HttpSessionContext	getSessionContext() Deprecated.
SessionManager	getSessionManager()
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()
boolean	isIdChanged()
boolean	isNew()
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)
void	removeValue(String name) Deprecated. As of Version 2.2, this method is replaced by removeAttribute(java.lang.String)
void	renewId(HttpServletRequest request)
void	setAttribute(String name, Object value)
protected void	setClusterId(String clusterId)
void	setCookieSetTime(long time)
void	setIdChanged(boolean changed)
void	setLastAccessedTime(long time)
void	setMaxInactiveInterval(int secs)
protected void	setNodeId(String nodeId)
void	setRequests(int requests)
protected void	timeout()
String	toString()
void	unbindValue(String name, Object value) Unbind value if value implements HttpSessionBindingListener (calls HttpSessionBindingListener.valueUnbound(HttpSessionBindingEvent))
protected boolean	updateAttribute(String name, Object value) Deprecated. use changeAttribute(String,Object) instead
void	willPassivate()

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_CREATED_SECURE

public static final String SESSION_CREATED_SECURE

See Also:

Constant Field Values

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 - if the sesion is invalid

checkExpiry

protected boolean checkExpiry(long time)

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

Parameters:

time - the time in milliseconds

Returns:

true if expired

getSession

public AbstractSession getSession()

Specified by:

getSession in interface AbstractSessionManager.SessionIf

getAccessed

public long getAccessed()

getAttributeMap

public abstract Map<String,Object> getAttributeMap()

getAttributes

public abstract int getAttributes()

getNames

public abstract Set<String> getNames()

getCookieSetTime

public long getCookieSetTime()

setCookieSetTime

public void setCookieSetTime(long time)

getCreationTime

public long getCreationTime()
                     throws IllegalStateException

Specified by:

getCreationTime in interface HttpSession

Throws:

IllegalStateException

getId

public String getId()
             throws IllegalStateException

Specified by:

getId in interface HttpSession

Throws:

IllegalStateException

getNodeId

public String getNodeId()

getClusterId

public String getClusterId()

getLastAccessedTime

public long getLastAccessedTime()
                         throws IllegalStateException

Specified by:

getLastAccessedTime in interface HttpSession

Throws:

IllegalStateException

setLastAccessedTime

public void setLastAccessedTime(long time)

getMaxInactiveInterval

public int getMaxInactiveInterval()

Specified by:

getMaxInactiveInterval in interface HttpSession

getServletContext

public ServletContext getServletContext()

Specified by:

getServletContext in interface HttpSession

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

Throws:

IllegalStateException

renewId

public void renewId(HttpServletRequest request)

getSessionManager

public SessionManager getSessionManager()

setClusterId

protected void setClusterId(String clusterId)

setNodeId

protected void setNodeId(String nodeId)

access

protected boolean access(long time)

complete

protected void complete()

timeout

protected void timeout()
                throws IllegalStateException

Throws:

IllegalStateException

invalidate

public void invalidate()
                throws IllegalStateException

Specified by:

invalidate in interface HttpSession

Throws:

IllegalStateException

doInvalidate

protected void doInvalidate()
                     throws IllegalStateException

Throws:

IllegalStateException

clearAttributes

public abstract void clearAttributes()

isIdChanged

public boolean isIdChanged()

isNew

public boolean isNew()
              throws IllegalStateException

Specified by:

isNew in interface HttpSession

Throws:

IllegalStateException

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

Throws:

IllegalStateException

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface HttpSession

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

Throws:

IllegalStateException

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface HttpSession

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

Throws:

IllegalStateException

doPutOrRemove

public abstract Object doPutOrRemove(String name,
                                     Object value)

doGet

public abstract Object doGet(String name)

doGetAttributeNames

public abstract Enumeration<String> doGetAttributeNames()

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface HttpSession

setAttribute

public void setAttribute(String name,
                         Object value)

Specified by:

setAttribute in interface HttpSession

updateAttribute

@Deprecated
protected boolean updateAttribute(String name,
                                              Object value)

Deprecated. use changeAttribute(String,Object) instead

Parameters:

name - the name of the attribute

value - the value of the attribute

Returns:

true if attribute changed

changeAttribute

protected Object changeAttribute(String name,
                                 Object value)

Either set (perhaps replace) or remove the value of the attribute in the session. The appropriate session attribute listeners are also called.

Parameters:

name - the name of the attribute

value - the value of the attribute

Returns:

the old value for the attribute

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

setIdChanged

public void setIdChanged(boolean changed)

setMaxInactiveInterval

public void setMaxInactiveInterval(int secs)

Specified by:

setMaxInactiveInterval in interface HttpSession

toString

public String toString()

Overrides:

toString in class Object

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

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)

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

willPassivate

public void willPassivate()

didActivate

public void didActivate()