Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private final Session.API	_api
protected String	_extendedId
protected 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
private final List<Session.ValueListener>	_valueListenerList
private static final Logger	LOG
public static final String	SESSION_CREATED_SECURE Deprecated Attribute set if the session is secure

Constructor Summary

Access	Constructor and Description
public	ManagedSession(SessionManager the SessionHandler that manages this session manager, SessionData the session data data) Create a new session object.

Method Summary

Modifier and Type	Method and Description
public boolean	access(long time)
public boolean	beginInvalidate() Returns: true if the session is not already invalid or being invalidated.
public long	Returns: the time remaining before expiry or inactivity timeout calculateInactivityTimeout(long the time at which to calculate remaining expiry 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.
public String	encodeURI(Request request, String uri, boolean cookiesInUse) Implements org.eclipse.jetty.server.Session.encodeURI.
public void	finishInvalidate() Call HttpSessionAttributeListeners as part of invalidating a Session.
public HttpCookie	generateSetCookie(String name, Map<String, String> attributes)
public < The type of the `API` T extends Session.API> T	Returns: The `API` wrapper of this core `ManagedSession`. getApi() Implements org.eclipse.jetty.server.Session.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.
public Object	getAttribute(String the attribute to get name) Implements org.eclipse.jetty.util.Attributes.getAttribute. Get an attribute
public Set<String>	getAttributeNameSet() Implements org.eclipse.jetty.util.Attributes.getAttributeNameSet. Get the immutable set of attribute names.
public long	getCookieSetTime()
public long	getCreationTime()
public String	getExtendedId() Implements org.eclipse.jetty.server.Session.getExtendedId.
public String	getId() Implements org.eclipse.jetty.server.Session.getId.
public long	getLastAccessedTime() Implements org.eclipse.jetty.server.Session.getLastAccessedTime.
public int	getMaxInactiveInterval() Implements org.eclipse.jetty.server.Session.getMaxInactiveInterval.
public long	Returns: the number of active requests for this session getRequests() Returns the current number of requests that are active in the Session.
public SessionData	getSessionData()
public SessionManager	getSessionManager()
public String	getVHost()
public void	invalidate() Implements org.eclipse.jetty.server.Session.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
public boolean	Returns: true if expired isExpiredAt(long the time since the epoch in ms time) Check to see if session has expired as at the time given.
protected boolean	Returns: true if the session has been idle longer than the interval isIdleLongerThan(int the number of seconds sec) Check if the Session has been idle longer than a number of seconds.
public boolean	isInvalidOrInvalidating()
public boolean	isNew() Implements org.eclipse.jetty.server.Session.isNew.
public boolean	isResident()
public boolean	isSetCookieNeeded()
public boolean	isValid() Implements org.eclipse.jetty.server.Session.isValid.
public AutoLock	Returns: the lock lock() Grab the lock on the session
public void	onIdChanged()
public void	onSessionActivation() Call the activation listeners.
protected void	onSessionAttributeUpdate(String name of the attribute name, Object new value of the attribute newValue, Object previous value of the attribute oldValue) Call binding and attribute listeners based on the new and old values of the attribute.
public void	onSessionPassivation() Call the passivation listeners.
pack-priv void	onSetCookieGenerated() Set the time that the cookie was set and clear the idChanged flag.
pack-priv void	release()
public Object	removeAttribute(String the attribute to remove name) Implements org.eclipse.jetty.util.Attributes.removeAttribute. Remove an attribute
public void	renewId(Request the Request associated with the call to change id. request, Response The response which may be updated with the new session identity. response) Implements org.eclipse.jetty.server.Session.renewId. Force a change to the id of a session.
public Object	setAttribute(String the attribute to set name, Object the value to set. A null value is equivalent to removing the attribute. value) Implements org.eclipse.jetty.util.Attributes.setAttribute. Set an attribute
public void	setExtendedId(String extendedId)
public void	setMaxInactiveInterval(int The period in secs in which the session will remain valid (unless explicitly invalidated) when not accessed by any requests. secs) Implements org.eclipse.jetty.server.Session.setMaxInactiveInterval.
public void	setResident(boolean resident)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected void	use()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_api	back to summary
private final Session.API _api

_extendedId	back to summary
protected String _extendedId

_lock	back to summary
protected AutoLock _lock

_manager	back to summary
protected final SessionManager _manager

_needSetCookie	back to summary
protected boolean _needSetCookie

_newSession	back to summary
protected boolean _newSession

_requests	back to summary
protected long _requests

_resident	back to summary
protected boolean _resident

_sessionData	back to summary
protected final SessionData _sessionData

_sessionInactivityTimer	back to summary
protected final SessionInactivityTimer _sessionInactivityTimer

_state	back to summary
protected ManagedSession.State _state

_stateChangeCompleted	back to summary
protected Condition _stateChangeCompleted

_valueListenerList	back to summary
private final List<Session.ValueListener> _valueListenerList

LOG	back to summary
private static final Logger LOG

SESSION_CREATED_SECURE	back to summary
public static final String SESSION_CREATED_SECURE Deprecated Attribute set if the session is secure Annotations @Deprecated

Constructor Detail

ManagedSession	back to summary
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:SessionManager the SessionHandler that manages this session data:SessionData the session data

ManagedSession

back to summary

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:SessionManager: the SessionHandler that manages this session
data:SessionData: the session data

Method Detail

access	back to summary
public boolean access(long time)

beginInvalidate	back to summary
public boolean beginInvalidate() Returns:boolean true if the session is not already invalid or being invalidated.

calculateInactivityTimeout	back to summary
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:long the time at which to calculate remaining expiry Returns:long the time remaining before expiry or inactivity timeout

calculateInactivityTimeout

back to summary

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:long: the time at which to calculate remaining expiry

Returns:long

the time remaining before expiry or inactivity timeout

checkValidForRead	back to summary
protected void checkValidForRead() throws IllegalStateException Chech that the session data can be read. Exceptions IllegalStateException: if the session is invalid

checkValidForRead

back to summary

protected void checkValidForRead() throws IllegalStateException

Chech that the session data can be read.

Exceptions

IllegalStateException:: if the session is invalid

checkValidForWrite	back to summary
protected void checkValidForWrite() throws IllegalStateException Check that the session can be modified. Exceptions IllegalStateException: if the session is invalid

checkValidForWrite

back to summary

protected void checkValidForWrite() throws IllegalStateException

Check that the session can be modified.

Exceptions

IllegalStateException:: if the session is invalid

encodeURI	back to summary
public String encodeURI(Request request, String uri, boolean cookiesInUse) Implements org.eclipse.jetty.server.Session.encodeURI. Annotations @Override

encodeURI

back to summary

public String encodeURI(Request request, String uri, boolean cookiesInUse)

Implements org.eclipse.jetty.server.Session.encodeURI.

Annotations

@Override

finishInvalidate	back to summary
public void finishInvalidate() throws IllegalStateException Call HttpSessionAttributeListeners as part of invalidating a Session. Exceptions IllegalStateException: if no session manager can be find

finishInvalidate

back to summary

public void finishInvalidate() throws IllegalStateException

Call HttpSessionAttributeListeners as part of invalidating a Session.

Exceptions

IllegalStateException:: if no session manager can be find

generateSetCookie	back to summary
public HttpCookie generateSetCookie(String name, Map<String, String> attributes)

getApi back to summary

getApi	back to summary
public <T extends Session.API> T getApi() Implements org.eclipse.jetty.server.Session.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. Parameters <T> The type of the `API` Returns:T The `API` wrapper of this core `ManagedSession`. Annotations @Override @SuppressWarnings:unchecked

public <T extends Session.API> T getApi()

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

Parameters

<T>: The type of the API

Returns:T

The API wrapper of this core ManagedSession.

Annotations

@Override
@SuppressWarnings:unchecked

getAttribute	back to summary
public Object getAttribute(String name) Implements org.eclipse.jetty.util.Attributes.getAttribute. Doc from org.eclipse.jetty.util.Attributes.getAttribute. Get an attribute Parameters name:String the attribute to get Returns:Object the value of the attribute Annotations @Override

getAttribute

back to summary

public Object getAttribute(String name)

Implements org.eclipse.jetty.util.Attributes.getAttribute.

Doc from org.eclipse.jetty.util.Attributes.getAttribute.

Get an attribute

Parameters

name:String: the attribute to get

Returns:Object

the value of the attribute

Annotations

@Override

getAttributeNameSet	back to summary
public Set<String> getAttributeNameSet() Implements org.eclipse.jetty.util.Attributes.getAttributeNameSet. Doc from org.eclipse.jetty.util.Attributes.getAttributeNameSet. Get the immutable set of attribute names. Returns:Set<String> Set of attribute names Annotations @Override

getAttributeNameSet

back to summary

public Set<String> getAttributeNameSet()

Implements org.eclipse.jetty.util.Attributes.getAttributeNameSet.

Doc from org.eclipse.jetty.util.Attributes.getAttributeNameSet.

Get the immutable set of attribute names.

Returns:Set<String>

Set of attribute names

Annotations

@Override

getCookieSetTime	back to summary
public long getCookieSetTime()

getCreationTime	back to summary
public long getCreationTime() throws IllegalStateException

getExtendedId back to summary

getExtendedId	back to summary
public String getExtendedId() Implements org.eclipse.jetty.server.Session.getExtendedId. Returns:String Doc from org.eclipse.jetty.server.Session.getExtendedId. The session identifier as returned by `getId()` extended with additional routing information. The additional information does not form part of the identity, but may be used by implementations and associated infrastructure to help route request for the same session to the same server. Annotations @Override

public String getExtendedId()

Implements org.eclipse.jetty.server.Session.getExtendedId.

Returns:String

Doc from org.eclipse.jetty.server.Session.getExtendedId.

The session identifier as returned by getId() extended with additional routing information. The additional information does not form part of the identity, but may be used by implementations and associated infrastructure to help route request for the same session to the same server.

Annotations

@Override

getId	back to summary
public String getId() Implements org.eclipse.jetty.server.Session.getId. Returns:String Doc from org.eclipse.jetty.server.Session.getId. A identifier for the session. Depending on the implementation may be unique within the context, the server, the JVM or a cluster. Annotations @Override

getId

back to summary

public String getId()

Implements org.eclipse.jetty.server.Session.getId.

Returns:String

Doc from org.eclipse.jetty.server.Session.getId.

A identifier for the session. Depending on the implementation may be unique within the context, the server, the JVM or a cluster.

Annotations

@Override

getLastAccessedTime back to summary

getLastAccessedTime	back to summary
public long getLastAccessedTime() Implements org.eclipse.jetty.server.Session.getLastAccessedTime. Returns:long Doc from org.eclipse.jetty.server.Session.getLastAccessedTime. the time, as represented by `System#currentTimeMillis()`, that the session was last accessed by a request. Annotations @Override

public long getLastAccessedTime()

Implements org.eclipse.jetty.server.Session.getLastAccessedTime.

Returns:long

Doc from org.eclipse.jetty.server.Session.getLastAccessedTime.

the time, as represented by System#currentTimeMillis(), that the session was last accessed by a request.

Annotations

@Override

getMaxInactiveInterval	back to summary
public int getMaxInactiveInterval() Implements org.eclipse.jetty.server.Session.getMaxInactiveInterval. Returns:int Doc from org.eclipse.jetty.server.Session.getMaxInactiveInterval. The period in secs in which the session will remain valid (unless explicitly invalidated) when not accessed by any requests. Annotations @Override

getMaxInactiveInterval

back to summary

public int getMaxInactiveInterval()

Implements org.eclipse.jetty.server.Session.getMaxInactiveInterval.

Returns:int

Doc from org.eclipse.jetty.server.Session.getMaxInactiveInterval.

The period in secs in which the session will remain valid (unless explicitly invalidated) when not accessed by any requests.

Annotations

@Override

getRequests	back to summary
public long getRequests() Returns the current number of requests that are active in the Session. Returns:long the number of active requests for this session

getRequests

back to summary

public long getRequests()

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

Returns:long: the number of active requests for this session

getSessionData	back to summary
public SessionData getSessionData()

getSessionManager	back to summary
public SessionManager getSessionManager()

getVHost	back to summary
public String getVHost()

invalidate	back to summary
public void invalidate() Implements org.eclipse.jetty.server.Session.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 Annotations @Override

invalidate

back to summary

public void invalidate()

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

Annotations

@Override

isExpiredAt	back to summary
public boolean isExpiredAt(long time) Check to see if session has expired as at the time given. Parameters time:long the time since the epoch in ms Returns:boolean true if expired

isExpiredAt

back to summary

public boolean isExpiredAt(long time)

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

Parameters

time:long: the time since the epoch in ms

Returns:boolean

true if expired

isIdleLongerThan	back to summary
protected boolean isIdleLongerThan(int sec) Check if the Session has been idle longer than a number of seconds. Parameters sec:int the number of seconds Returns:boolean true if the session has been idle longer than the interval

isIdleLongerThan

back to summary

protected boolean isIdleLongerThan(int sec)

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

Parameters

sec:int: the number of seconds

Returns:boolean

true if the session has been idle longer than the interval

isInvalidOrInvalidating	back to summary
public boolean isInvalidOrInvalidating()

isNew back to summary

isNew	back to summary
public boolean isNew() throws IllegalStateException Implements org.eclipse.jetty.server.Session.isNew. Returns:boolean Doc from org.eclipse.jetty.server.Session.isNew. `true` if the session has been newly created within the scope of the current request. Annotations @Override

public boolean isNew() throws IllegalStateException

Implements org.eclipse.jetty.server.Session.isNew.

Returns:boolean

Doc from org.eclipse.jetty.server.Session.isNew.

true if the session has been newly created within the scope of the current request.

Annotations

@Override

isResident	back to summary
public boolean isResident()

isSetCookieNeeded	back to summary
public boolean isSetCookieNeeded()

isValid	back to summary
public boolean isValid() Implements org.eclipse.jetty.server.Session.isValid. Returns:boolean Doc from org.eclipse.jetty.server.Session.isValid. true if the session is has not been invalidated nor expired due to inactivity. Annotations @Override

isValid

back to summary

public boolean isValid()

Implements org.eclipse.jetty.server.Session.isValid.

Returns:boolean

Doc from org.eclipse.jetty.server.Session.isValid.

true if the session is has not been invalidated nor expired due to inactivity.

Annotations

@Override

lock	back to summary
public AutoLock lock() Grab the lock on the session Returns:AutoLock the lock

lock

back to summary

public AutoLock lock()

Grab the lock on the session

Returns:AutoLock: the lock

onIdChanged	back to summary
public void onIdChanged()

onSessionActivation	back to summary
public void onSessionActivation() Call the activation listeners. This must be called holding the lock.

onSessionAttributeUpdate

back to summary

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:String: name of the attribute
newValue:Object: new value of the attribute
oldValue:Object: previous value of the attribute

Exceptions

IllegalStateException:: if no session manager can be find

onSessionPassivation	back to summary
public void onSessionPassivation() Call the passivation listeners. This must be called holding the lock

onSetCookieGenerated	back to summary
pack-priv void onSetCookieGenerated() Set the time that the cookie was set and clear the idChanged flag.

release	back to summary
pack-priv void release()

removeAttribute

back to summary

public Object removeAttribute(String name)

Implements org.eclipse.jetty.util.Attributes.removeAttribute.

Doc from org.eclipse.jetty.util.Attributes.removeAttribute.

Remove an attribute

Parameters

name:String: the attribute to remove

Returns:Object

the value of the attribute if removed, else null

Annotations

@Override

renewId

back to summary

public void renewId(Request request, Response response)

Implements org.eclipse.jetty.server.Session.renewId.

Force a change to the id of a session.

Parameters

request:Request

the Request associated with the call to change id.

response:Response

Doc from org.eclipse.jetty.server.Session.renewId.

The response which may be updated with the new session identity.

Annotations

@Override

setAttribute

back to summary

public Object setAttribute(String name, Object value)

Implements org.eclipse.jetty.util.Attributes.setAttribute.

Doc from org.eclipse.jetty.util.Attributes.setAttribute.

Set an attribute

Parameters

name:String: the attribute to set
value:Object: the value to set. A null value is equivalent to removing the attribute.

Returns:Object

the previous value of the attribute if set, else null

Annotations

@Override

setExtendedId	back to summary
public void setExtendedId(String extendedId)

setMaxInactiveInterval

back to summary

public void setMaxInactiveInterval(int secs)

Implements org.eclipse.jetty.server.Session.setMaxInactiveInterval.

Parameters

secs:int

Doc from org.eclipse.jetty.server.Session.setMaxInactiveInterval.

The period in secs in which the session will remain valid (unless explicitly invalidated) when not accessed by any requests.

Annotations

@Override

setResident	back to summary
public void setResident(boolean resident)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

use	back to summary
protected void use()

org.eclipse.jetty.session back to summary

public final Enum ManagedSession.IdState

Class Inheritance

extends Enum<ManagedSession.IdState>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.session.ManagedSession.IdState

State of the session id

Field Summary

Modifier and Type	Field and Description
public static final ManagedSession.IdState	CHANGING
public static final ManagedSession.IdState	SET

Constructor Summary

Access	Constructor and Description
private	IdState()

Method Summary

Modifier and Type	Method and Description
public static ManagedSession.IdState	valueOf(String name)
public static ManagedSession.IdState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CHANGING	back to summary
public static final ManagedSession.IdState CHANGING

SET	back to summary
public static final ManagedSession.IdState SET

Constructor Detail

IdState	back to summary
private IdState()

Method Detail

valueOf	back to summary
public static ManagedSession.IdState valueOf(String name)

values	back to summary
public static ManagedSession.IdState[] values()

org.eclipse.jetty.session back to summary

public final Enum ManagedSession.State

Class Inheritance

extends Enum<ManagedSession.State>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.session.ManagedSession.State

Validity states of a session

Field Summary

Modifier and Type	Field and Description
public static final ManagedSession.State	CHANGING
public static final ManagedSession.State	INVALID
public static final ManagedSession.State	INVALIDATING
public static final ManagedSession.State	VALID

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static ManagedSession.State	valueOf(String name)
public static ManagedSession.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CHANGING	back to summary
public static final ManagedSession.State CHANGING

INVALID	back to summary
public static final ManagedSession.State INVALID

INVALIDATING	back to summary
public static final ManagedSession.State INVALIDATING

VALID	back to summary
public static final ManagedSession.State VALID

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static ManagedSession.State valueOf(String name)

values	back to summary
public static ManagedSession.State[] values()

public Class ManagedSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ManagedSession.IdState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ManagedSession.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail