Module org.eclipse.jetty.session

Package org.eclipse.jetty.session

Class SessionData

java.lang.Object

org.eclipse.jetty.session.SessionData

All Implemented Interfaces:

Serializable

public class SessionData
extends Object
implements Serializable

The data associated with a session. A Session object has a 1:1 relationship with a SessionData object. The behaviour of sessions is implemented in the Session object (eg calling listeners, keeping timers etc). A Session's associated SessionData is the object which can be persisted, serialized etc.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected long	_accessed
protected Map<String,Object>	_attributes
protected String	_contextPath
protected long	_cookieSet
protected long	_created
protected boolean	_dirty
protected long	_expiry
protected String	_id
protected long	_lastAccessed
protected String	_lastNode
protected long	_lastSaved
protected long	_maxInactiveMs
protected boolean	_metaDataDirty
protected String	_vhost

Constructor Summary

Constructors

Constructor	Description
SessionData(String id, String cpath, String vhost, long created, long accessed, long lastAccessed, long maxInactiveMs)
SessionData(String id, String cpath, String vhost, long created, long accessed, long lastAccessed, long maxInactiveMs, Map<String,Object> attributes)

Method Summary

Modifier and Type	Method	Description
void	calcAndSetExpiry()
void	calcAndSetExpiry(long time)
long	calcExpiry()
long	calcExpiry(long time)
void	clean()	Clear all dirty flags.
void	clearAllAttributes()	Remove all attributes
void	copy(SessionData data)	Copy the info from the given sessiondata
static void	deserializeAttributes(SessionData data, ObjectInputStream in)	De-serialize the attribute map of a session.
long	getAccessed()	Get time session was accessed.
Map<String,Object>	getAllAttributes()
Object	getAttribute(String name)
String	getContextPath()	Get the context path associated with this session.
long	getCookieSet()	Get time cookie was set.
long	getCreated()
long	getExpiry()	Get time at which session expires.
String	getId()	Get the id of the session.
Set<String>	getKeys()
long	getLastAccessed()	Get previous time session was accessed.
String	getLastNode()	Get last node to manage the session.
long	getLastSaved()	Get time at which session was last written out.
long	getMaxInactiveMs()
String	getVhost()	Get virtual host of context associated with session.
boolean	isDirty()
boolean	isExpiredAt(long time)
boolean	isMetaDataDirty()
void	putAllAttributes(Map<String,Object> attributes)
static void	serializeAttributes(SessionData data, ObjectOutputStream out)	Serialize the attribute map of the session.
void	setAccessed(long accessed)
Object	setAttribute(String name, Object value)
void	setContextPath(String contextPath)
void	setCookieSet(long cookieSet)
void	setCreated(long created)
void	setDirty(boolean dirty)
void	setDirty(String name)
void	setExpiry(long expiry)
void	setId(String id)
void	setLastAccessed(long lastAccessed)
void	setLastNode(String lastNode)
void	setLastSaved(long lastSaved)
void	setMaxInactiveMs(long maxInactive)
void	setMetaDataDirty(boolean metaDataDirty)	Set true means non-attribute data has changed.
void	setVhost(String vhost)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_id

protected String _id

_contextPath

protected String _contextPath

_vhost

protected String _vhost

_lastNode

protected String _lastNode

_expiry

protected long _expiry

_created

protected long _created

_cookieSet

protected long _cookieSet

_accessed

protected long _accessed

_lastAccessed

protected long _lastAccessed

_maxInactiveMs

protected long _maxInactiveMs

_attributes

protected Map<String,Object> _attributes

_dirty

protected boolean _dirty

_lastSaved

protected long _lastSaved

_metaDataDirty

protected boolean _metaDataDirty

Constructor Details

SessionData

public SessionData(String id,
 String cpath,
 String vhost,
 long created,
 long accessed,
 long lastAccessed,
 long maxInactiveMs)

SessionData

public SessionData(String id,
 String cpath,
 String vhost,
 long created,
 long accessed,
 long lastAccessed,
 long maxInactiveMs,
 Map<String,Object> attributes)

Method Details

serializeAttributes

public static void serializeAttributes(SessionData data,
 ObjectOutputStream out)
                                throws IOException

Serialize the attribute map of the session. This special handling allows us to record which classloader should be used to load the value of the attribute: either the container classloader (which could be the application loader ie null, or jetty's startjar loader) or the webapp's classloader.

Parameters:

data - the SessionData for which to serialize the attributes

out - the stream to which to serialize

Throws:

IOException

deserializeAttributes

public static void deserializeAttributes(SessionData data,
 ObjectInputStream in)
                                  throws IOException,
ClassNotFoundException

De-serialize the attribute map of a session. When the session was serialized, we will have recorded which classloader should be used to recover the attribute value. The classloader could be the container classloader, or the webapp classloader.

Parameters:

data - the SessionData for which to deserialize the attribute map

in - the serialized stream

Throws:

IOException

ClassNotFoundException

copy

public void copy(SessionData data)

Copy the info from the given sessiondata

Parameters:

data - the sessiondata to be copied

getLastSaved

public long getLastSaved()

Get time at which session was last written out.

Returns:

time at which session was last written out

setLastSaved

public void setLastSaved(long lastSaved)

isDirty

public boolean isDirty()

Returns:

true if a session needs to be written out

setDirty

public void setDirty(boolean dirty)

setDirty

public void setDirty(String name)

isMetaDataDirty

public boolean isMetaDataDirty()

Returns:

the metaDataDirty

setMetaDataDirty

public void setMetaDataDirty(boolean metaDataDirty)

Set true means non-attribute data has changed.

Parameters:

metaDataDirty - true means non-attribute data has changed

getAttribute

public Object getAttribute(String name)

Parameters:

name - the name of the attribute

Returns:

the value of the attribute named

getKeys

public Set<String> getKeys()

Returns:

a Set of attribute names

setAttribute

public Object setAttribute(String name,
 Object value)

clean

public void clean()

Clear all dirty flags.

putAllAttributes

public void putAllAttributes(Map<String,Object> attributes)

clearAllAttributes

public void clearAllAttributes()

Remove all attributes

getAllAttributes

public Map<String,Object> getAllAttributes()

Returns:

an unmodifiable map of the attributes

getId

public String getId()

Get the id of the session.

Returns:

the id of the session

setId

public void setId(String id)

getContextPath

public String getContextPath()

Get the context path associated with this session.

Returns:

the context path associated with this session

setContextPath

public void setContextPath(String contextPath)

getVhost

public String getVhost()

Get virtual host of context associated with session.

Returns:

virtual host of context associated with session

setVhost

public void setVhost(String vhost)

getLastNode

public String getLastNode()

Get last node to manage the session.

Returns:

last node to manage the session

setLastNode

public void setLastNode(String lastNode)

getExpiry

public long getExpiry()

Get time at which session expires.

Returns:

time at which session expires

setExpiry

public void setExpiry(long expiry)

calcExpiry

public long calcExpiry()

calcExpiry

public long calcExpiry(long time)

calcAndSetExpiry

public void calcAndSetExpiry(long time)

calcAndSetExpiry

public void calcAndSetExpiry()

getCreated

public long getCreated()

setCreated

public void setCreated(long created)

getCookieSet

public long getCookieSet()

Get time cookie was set.

Returns:

time cookie was set

setCookieSet

public void setCookieSet(long cookieSet)

getAccessed

public long getAccessed()

Get time session was accessed.

Returns:

time session was accessed

setAccessed

public void setAccessed(long accessed)

getLastAccessed

public long getLastAccessed()

Get previous time session was accessed.

Returns:

previous time session was accessed

setLastAccessed

public void setLastAccessed(long lastAccessed)

getMaxInactiveMs

public long getMaxInactiveMs()

setMaxInactiveMs

public void setMaxInactiveMs(long maxInactive)

isExpiredAt

public boolean isExpiredAt(long time)

toString

public String toString()

Overrides:

toString in class Object