Module org.eclipse.jetty.session

Package org.eclipse.jetty.session

Class ManagedSession

java.lang.Object

org.eclipse.jetty.session.ManagedSession

All Implemented Interfaces:

org.eclipse.jetty.server.Session, org.eclipse.jetty.util.Attributes

public class ManagedSession
extends Object
implements org.eclipse.jetty.server.Session

A heavy-weight Session object representing an HttpSession. Session objects relating to a context are kept in a SessionCache. The purpose of the SessionCache is to keep the working set of Session objects in memory so that they may be accessed quickly, and facilitate the sharing of a Session object amongst multiple simultaneous requests referring to the same session id.

The SessionManager coordinates the lifecycle of Session objects with the help of the SessionCache/SessionDataStore.

See Also:

• SessionManager
• SessionIdManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ManagedSession.IdState	State of the session id
static enum	ManagedSession.State	Validity states of a session

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Attributes

org.eclipse.jetty.util.Attributes.Layer, org.eclipse.jetty.util.Attributes.Lazy, org.eclipse.jetty.util.Attributes.Mapped, org.eclipse.jetty.util.Attributes.Synthetic, org.eclipse.jetty.util.Attributes.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Session

org.eclipse.jetty.server.Session.API, org.eclipse.jetty.server.Session.LifeCycleListener, org.eclipse.jetty.server.Session.ValueListener

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_extendedId
protected org.eclipse.jetty.util.thread.AutoLock	_lock
protected final SessionManager	_manager
protected boolean	_needSetCookie
protected boolean	_newSession
protected long	_requests
protected boolean	_resident
protected final SessionData	_sessionData
protected final SessionInactivityTimer	_sessionInactivityTimer
protected ManagedSession.State	_state
protected Condition	_stateChangeCompleted
static final String	SESSION_CREATED_SECURE	Deprecated.

Fields inherited from interface org.eclipse.jetty.util.Attributes

NULL

Constructor Summary

Constructors

Constructor	Description
ManagedSession(SessionManager manager, SessionData data)	Create a new session object.

Method Summary

Modifier and Type	Method	Description
boolean	access(long time)
boolean	beginInvalidate()
long	calculateInactivityTimeout(long now)	Calculate what the session timer setting should be based on: the time remaining before the session expires and any idle eviction time configured.
protected void	checkValidForRead()	Chech that the session data can be read.
protected void	checkValidForWrite()	Check that the session can be modified.
String	encodeURI(org.eclipse.jetty.server.Request request, String uri, boolean cookiesInUse)
void	finishInvalidate()	Call HttpSessionAttributeListeners as part of invalidating a Session.
org.eclipse.jetty.http.HttpCookie	generateSetCookie(String name, Map<String,String> attributes)
<T extends org.eclipse.jetty.server.Session.API> T	getApi()	A ManagedSession may have an API wrapper (e.g.
Object	getAttribute(String name)
Set<String>	getAttributeNameSet()
long	getCookieSetTime()
long	getCreationTime()
String	getExtendedId()
String	getId()
long	getLastAccessedTime()
int	getMaxInactiveInterval()
long	getRequests()	Returns the current number of requests that are active in the Session.
SessionData	getSessionData()
SessionManager	getSessionManager()
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
boolean	isExpiredAt(long time)	Check to see if session has expired as at the time given.
protected boolean	isIdleLongerThan(int sec)	Check if the Session has been idle longer than a number of seconds.
boolean	isInvalidOrInvalidating()
boolean	isNew()
boolean	isResident()
boolean	isSetCookieNeeded()
boolean	isValid()
org.eclipse.jetty.util.thread.AutoLock	lock()	Grab the lock on the session
void	onIdChanged()
void	onSessionActivation()	Call the activation listeners.
protected void	onSessionAttributeUpdate(String name, Object newValue, Object oldValue)	Call binding and attribute listeners based on the new and old values of the attribute.
void	onSessionPassivation()	Call the passivation listeners.
void	release()
Object	removeAttribute(String name)
void	renewId(org.eclipse.jetty.server.Request request, org.eclipse.jetty.server.Response response)	Force a change to the id of a session.
Object	setAttribute(String name, Object value)
void	setExtendedId(String extendedId)
void	setMaxInactiveInterval(int secs)
void	setResident(boolean resident)
String	toString()
protected void	use()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.Attributes

asAttributeMap, clearAttributes, equals, hashCode

Field Details

SESSION_CREATED_SECURE

@Deprecated
public static final String SESSION_CREATED_SECURE

Deprecated.

Attribute set if the session is secure

See Also:

• Constant Field Values

_sessionData

protected final SessionData _sessionData

_manager

protected final SessionManager _manager

_extendedId

protected String _extendedId

_requests

protected long _requests

_needSetCookie

protected boolean _needSetCookie

_newSession

protected boolean _newSession

_state

protected ManagedSession.State _state

_lock

protected org.eclipse.jetty.util.thread.AutoLock _lock

_stateChangeCompleted

protected Condition _stateChangeCompleted

_resident

protected boolean _resident

_sessionInactivityTimer

protected final SessionInactivityTimer _sessionInactivityTimer

Constructor Details

ManagedSession

public ManagedSession(SessionManager manager,
 SessionData data)

Create a new session object. The session could be an entirely new session, or could be being re-inflated from persistent store.

Parameters:

manager - the SessionHandler that manages this session

data - the session data

Method Details

getApi

public <T extends org.eclipse.jetty.server.Session.API>
T getApi()

A ManagedSession may have an API wrapper (e.g. Servlet API), that is created by the SessionManager.newSessionAPIWrapper(ManagedSession) method during construction of a ManagedSession instance.

Specified by:

getApi in interface org.eclipse.jetty.server.Session

Type Parameters:

T - The type of the Session.API

Returns:

The Session.API wrapper of this core ManagedSession.

getRequests

public long getRequests()

Returns the current number of requests that are active in the Session.

Returns:

the number of active requests for this session

setExtendedId

public void setExtendedId(String extendedId)

generateSetCookie

public org.eclipse.jetty.http.HttpCookie generateSetCookie(String name,
 Map<String,String> attributes)

use

protected void use()

access

public boolean access(long time)

release

public void release()

isExpiredAt

public boolean isExpiredAt(long time)

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

Parameters:

time - the time since the epoch in ms

Returns:

true if expired

isIdleLongerThan

protected boolean isIdleLongerThan(int sec)

Check if the Session has been idle longer than a number of seconds.

Parameters:

sec - the number of seconds

Returns:

true if the session has been idle longer than the interval

onSessionAttributeUpdate

protected void onSessionAttributeUpdate(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

Throws:

IllegalStateException - if no session manager can be find

onSessionActivation

public void onSessionActivation()

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

onSessionPassivation

public void onSessionPassivation()

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

isValid

public boolean isValid()

Specified by:

isValid in interface org.eclipse.jetty.server.Session

isInvalidOrInvalidating

public boolean isInvalidOrInvalidating()

getCookieSetTime

public long getCookieSetTime()

getCreationTime

public long getCreationTime()
                     throws IllegalStateException

Throws:

IllegalStateException

getId

public String getId()

Specified by:

getId in interface org.eclipse.jetty.server.Session

encodeURI

public String encodeURI(org.eclipse.jetty.server.Request request,
 String uri,
 boolean cookiesInUse)

Specified by:

encodeURI in interface org.eclipse.jetty.server.Session

getExtendedId

public String getExtendedId()

Specified by:

getExtendedId in interface org.eclipse.jetty.server.Session

getVHost

public String getVHost()

getLastAccessedTime

public long getLastAccessedTime()

Specified by:

getLastAccessedTime in interface org.eclipse.jetty.server.Session

setMaxInactiveInterval

public void setMaxInactiveInterval(int secs)

Specified by:

setMaxInactiveInterval in interface org.eclipse.jetty.server.Session

calculateInactivityTimeout

public long calculateInactivityTimeout(long now)

Calculate what the session timer setting should be based on: the time remaining before the session expires and any idle eviction time configured. The timer value will be the lesser of the above.

Parameters:

now - the time at which to calculate remaining expiry

Returns:

the time remaining before expiry or inactivity timeout

getMaxInactiveInterval

public int getMaxInactiveInterval()

Specified by:

getMaxInactiveInterval in interface org.eclipse.jetty.server.Session

getSessionManager

public SessionManager getSessionManager()

checkValidForWrite

protected void checkValidForWrite()
                           throws IllegalStateException

Check that the session can be modified.

Throws:

IllegalStateException - if the session is invalid

checkValidForRead

protected void checkValidForRead()
                          throws IllegalStateException

Chech that the session data can be read.

Throws:

IllegalStateException - if the session is invalid

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface org.eclipse.jetty.util.Attributes

getAttributeNameSet

public Set<String> getAttributeNameSet()

Specified by:

getAttributeNameSet in interface org.eclipse.jetty.util.Attributes

setAttribute

public Object setAttribute(String name,
 Object value)

Specified by:

setAttribute in interface org.eclipse.jetty.util.Attributes

removeAttribute

public Object removeAttribute(String name)

Specified by:

removeAttribute in interface org.eclipse.jetty.util.Attributes

renewId

public void renewId(org.eclipse.jetty.server.Request request,
 org.eclipse.jetty.server.Response response)

Force a change to the id of a session.

Specified by:

renewId in interface org.eclipse.jetty.server.Session

Parameters:

request - the Request associated with the call to change id.

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 org.eclipse.jetty.server.Session

lock

public org.eclipse.jetty.util.thread.AutoLock lock()

Grab the lock on the session

Returns:

the lock

beginInvalidate

public boolean beginInvalidate()

Returns:

true if the session is not already invalid or being invalidated.

finishInvalidate

public void finishInvalidate()
                      throws IllegalStateException

Call HttpSessionAttributeListeners as part of invalidating a Session.

Throws:

IllegalStateException - if no session manager can be find

isNew

public boolean isNew()
              throws IllegalStateException

Specified by:

isNew in interface org.eclipse.jetty.server.Session

Throws:

IllegalStateException

onIdChanged

public void onIdChanged()

isSetCookieNeeded

public boolean isSetCookieNeeded()

getSessionData

public SessionData getSessionData()

setResident

public void setResident(boolean resident)

isResident

public boolean isResident()

toString

public String toString()

Overrides:

toString in class Object