Modifier and Type	Class and Description
public static class	AbstractSessionManager.NullSessionContext Deprecated as a consequence of `HttpSessionContext` being deprecated. Null returning implementation of HttpSessionContext
public abstract class	AbstractSessionManager.Session Implements `javax.servlet.HttpSession` from the `javax.servlet` package.
public static interface	AbstractSessionManager.SessionIf Interface that any session wrapper should implement so that SessionManager may access the Jetty session implementation.

Modifier and Type	Field and Description
public static final int	__distantFuture
private static final HttpSessionContext	__nullSessionContext Deprecated as a consequence of `HttpSessionContext` being deprecated.
protected ContextHandler.SContext	_context
protected int	_dftMaxIdleSecs
protected boolean	_httpOnly
protected ClassLoader	_loader
protected int	_maxCookieAge
protected int	_maxSessions
protected int	_minSessions
protected boolean	_nodeIdInSessionId
protected int	_refreshCookieAge
protected boolean	_secureCookies
protected Object	_sessionAttributeListeners
protected String	_sessionCookie
protected String	_sessionDomain
protected SessionHandler	_sessionHandler
protected SessionIdManager	_sessionIdManager
protected String	_sessionIdPathParameterName
protected String	_sessionIdPathParameterNamePrefix
protected Object	_sessionListeners
protected String	_sessionPath
private boolean	_usingCookies

Access	Constructor and Description
public	AbstractSessionManager()

Method Summary

Modifier and Type	Method and Description
public Cookie	access(HttpSession the session object session, boolean whether the request is secure or not secure) Implements org.mortbay.jetty.SessionManager.access. Called by the `SessionHandler` when a session is first accessed by a request.
public void	addEventListener(EventListener the session event listener to add Individual SessionManagers implementations may accept arbitrary listener types, but they are expected to at least handle HttpSessionActivationListener, HttpSessionAttributeListener, HttpSessionBindingListener and HttpSessionListener. listener) Implements org.mortbay.jetty.SessionManager.addEventListener. Adds an event listener for session-related events.
protected abstract void	addSession(AbstractSessionManager.Session session)
protected void	addSession(AbstractSessionManager.Session session, boolean created) Add the session Registers the session with this manager and registers the session ID with the sessionIDManager;
public void	clearEventListeners() Implements org.mortbay.jetty.SessionManager.clearEventListeners. Removes all event listeners for session-related events.
public void	complete(HttpSession the session object session) Implements org.mortbay.jetty.SessionManager.complete. Called by the `SessionHandler` when a session is last accessed by a request.
public void	doStart() Overrides org.mortbay.component.AbstractLifeCycle.doStart.
public void	doStop() Overrides org.mortbay.component.AbstractLifeCycle.doStop.
public String	getClusterId(HttpSession the session object session) Implements org.mortbay.jetty.SessionManager.getClusterId.
public boolean	Returns: Returns the httpOnly. getHttpOnly() Implements org.mortbay.jetty.SessionManager.getHttpOnly.
public HttpSession	getHttpSession(String the session id nodeId) Implements org.mortbay.jetty.SessionManager.getHttpSession. Returns the `HttpSession` with the given session id
public SessionIdManager	Returns: Returns the metaManager used for cross context session management getIdManager() Implements org.mortbay.jetty.SessionManager.getIdManager.
public int	getMaxCookieAge() Implements org.mortbay.jetty.SessionManager.getMaxCookieAge.
public int	Returns: seconds getMaxInactiveInterval() Implements org.mortbay.jetty.SessionManager.getMaxInactiveInterval.
public int	getMaxSessions()
public SessionIdManager	getMetaManager() Implements org.mortbay.jetty.SessionManager.getMetaManager. Deprecated use `getIdManager()`
public int	getMinSessions()
public String	getNodeId(HttpSession the session object session) Implements org.mortbay.jetty.SessionManager.getNodeId.
public int	getRefreshCookieAge()
public boolean	Returns: Returns the secureCookies. getSecureCookies() Implements org.mortbay.jetty.SessionManager.getSecureCookies.
public abstract AbstractSessionManager.Session	Returns: A Session or null if none exists. getSession(String The session ID in the cluster, stripped of any worker name. idInCluster) Get a known existingsession
public String	getSessionCookie() Implements org.mortbay.jetty.SessionManager.getSessionCookie.
public Cookie	getSessionCookie(HttpSession the session to which the cookie should refer. session, String the context to which the cookie should be linked. The client will only send the cookie value when requesting resources under this path. contextPath, boolean whether the client is accessing the server over a secure protocol (i.e. HTTPS). requestIsSecure) Implements org.mortbay.jetty.SessionManager.getSessionCookie. Gets a Cookie for a session.
public String	getSessionDomain() Implements org.mortbay.jetty.SessionManager.getSessionDomain.
public SessionHandler	Returns: Returns the sessionHandler. getSessionHandler()
public String	getSessionIdPathParameterName() Implements org.mortbay.jetty.SessionManager.getSessionIdPathParameterName.
public String	getSessionIdPathParameterNamePrefix() Implements org.mortbay.jetty.SessionManager.getSessionIdPathParameterNamePrefix.
public abstract Map<K, V>	getSessionMap() Deprecated Need to review if it is needed.
public String	getSessionPath() Implements org.mortbay.jetty.SessionManager.getSessionPath.
public abstract int	getSessions()
protected abstract void	invalidateSessions()
public boolean	Returns: true if the cluster node id (worker id) is returned as part of the session id by `HttpSession#getId()`. Default is false. isNodeIdInSessionId()
public boolean	Returns: Returns the usingCookies. isUsingCookies() Implements org.mortbay.jetty.SessionManager.isUsingCookies.
public boolean	isValid(HttpSession the session to test for validity session) Implements org.mortbay.jetty.SessionManager.isValid.
public HttpSession	newHttpSession(HttpServletRequest the HttpServletRequest containing the requested session id request) Implements org.mortbay.jetty.SessionManager.newHttpSession. Create a new HttpSession for a request
protected abstract AbstractSessionManager.Session	newSession(HttpServletRequest request) Create a new session instance
public void	removeEventListener(EventListener the session event listener to remove listener) Implements org.mortbay.jetty.SessionManager.removeEventListener. Removes an event listener for for session-related events.
public void	removeSession(HttpSession The session to remove session, boolean True if `HttpSessionListener#sessionDestroyed(HttpSessionEvent)` and `SessionIdManager#invalidateAll(String)` should be called. invalidate) Remove session from manager
public void	removeSession(AbstractSessionManager.Session The session to remove session, boolean True if `HttpSessionListener#sessionDestroyed(HttpSessionEvent)` and `SessionIdManager#invalidateAll(String)` should be called. invalidate) Remove session from manager
protected abstract void	removeSession(String idInCluster)
public void	resetStats()
public void	setHttpOnly(boolean The httpOnly to set. httpOnly)
public void	setIdManager(SessionIdManager The metaManager used for cross context session management. metaManager) Implements org.mortbay.jetty.SessionManager.setIdManager. Sets the cross context session id manager
public void	setMaxCookieAge(int the max age to set on the session cookie, in seconds maxCookieAgeInSeconds) Implements org.mortbay.jetty.SessionManager.setMaxCookieAge. Sets the max age to set on the session cookie, in seconds
public void	setMaxInactiveInterval(int seconds) Implements org.mortbay.jetty.SessionManager.setMaxInactiveInterval. Sets the max period of inactivity, after which the session is invalidated, in seconds.
public void	setMetaManager(SessionIdManager metaManager) Deprecated use `setIdManager(SessionIdManager)`
public void	setNodeIdInSessionId(boolean true if the cluster node id (worker id) will be returned as part of the session id by `HttpSession#getId()`. Default is false. nodeIdInSessionId)
public void	setRefreshCookieAge(int ageInSeconds)
public void	setSecureCookies(boolean The secureCookies to set. secureCookies)
public void	setSessionCookie(String the session cookie name cookieName) Implements org.mortbay.jetty.SessionManager.setSessionCookie. Sets the session cookie name.
public void	setSessionDomain(String the domain to set on the session cookie domain) Implements org.mortbay.jetty.SessionManager.setSessionDomain. Sets the domain to set on the session cookie
public void	setSessionHandler(SessionHandler The sessionHandler to set. sessionHandler) Implements org.mortbay.jetty.SessionManager.setSessionHandler. Sets the `SessionHandler`.
public void	setSessionIdPathParameterName(String the URL path parameter name for session id URL rewriting (null or "none" for no rewriting). param) Implements org.mortbay.jetty.SessionManager.setSessionIdPathParameterName. Sets the session id URL path parameter name.
public void	setSessionPath(String the path to set on the session cookie path) Implements org.mortbay.jetty.SessionManager.setSessionPath. Sets the path to set on the session cookie
public void	setUsingCookies(boolean The usingCookies to set. usingCookies)

Inherited from org.mortbay.component.AbstractLifeCycle:: addLifeCycleListener isFailed isRunning isStarted isStarting isStopped isStopping removeLifeCycleListener start stop

Field Detail

__distantFuture	back to summary
public static final int __distantFuture

__nullSessionContext	back to summary
private static final HttpSessionContext __nullSessionContext Deprecated as a consequence of `HttpSessionContext` being deprecated. See corresponding docs for further information.

_context	back to summary
protected ContextHandler.SContext _context

_dftMaxIdleSecs	back to summary
protected int _dftMaxIdleSecs

_httpOnly	back to summary
protected boolean _httpOnly

_loader	back to summary
protected ClassLoader _loader

_maxCookieAge	back to summary
protected int _maxCookieAge

_maxSessions	back to summary
protected int _maxSessions

_minSessions	back to summary
protected int _minSessions

_nodeIdInSessionId	back to summary
protected boolean _nodeIdInSessionId

_refreshCookieAge	back to summary
protected int _refreshCookieAge

_secureCookies	back to summary
protected boolean _secureCookies

_sessionAttributeListeners	back to summary
protected Object _sessionAttributeListeners

_sessionCookie	back to summary
protected String _sessionCookie

_sessionDomain	back to summary
protected String _sessionDomain

_sessionHandler	back to summary
protected SessionHandler _sessionHandler

_sessionIdManager	back to summary
protected SessionIdManager _sessionIdManager

_sessionIdPathParameterName	back to summary
protected String _sessionIdPathParameterName

_sessionIdPathParameterNamePrefix	back to summary
protected String _sessionIdPathParameterNamePrefix

_sessionListeners	back to summary
protected Object _sessionListeners

_sessionPath	back to summary
protected String _sessionPath

_usingCookies	back to summary
private boolean _usingCookies

Constructor Detail

AbstractSessionManager	back to summary
public AbstractSessionManager()

Method Detail

access back to summary

access	back to summary
public Cookie access(HttpSession session, boolean secure) Implements org.mortbay.jetty.SessionManager.access. Doc from org.mortbay.jetty.SessionManager.access. Called by the `SessionHandler` when a session is first accessed by a request. Parameters session:HttpSession the session object secure:boolean whether the request is secure or not Returns:Cookie the session cookie. If not null, this cookie should be set on the response to either migrate the session or to refresh a session cookie that may expire.

public Cookie access(HttpSession session, boolean secure)

Implements org.mortbay.jetty.SessionManager.access.

Doc from org.mortbay.jetty.SessionManager.access.

Called by the SessionHandler when a session is first accessed by a request.

Parameters

session:HttpSession: the session object
secure:boolean: whether the request is secure or not

Returns:Cookie

the session cookie. If not null, this cookie should be set on the response to either migrate the session or to refresh a session cookie that may expire.

addEventListener	back to summary
public void addEventListener(EventListener listener) Implements org.mortbay.jetty.SessionManager.addEventListener. Doc from org.mortbay.jetty.SessionManager.addEventListener. Adds an event listener for session-related events. Parameters listener:EventListener the session event listener to add Individual SessionManagers implementations may accept arbitrary listener types, but they are expected to at least handle HttpSessionActivationListener, HttpSessionAttributeListener, HttpSessionBindingListener and HttpSessionListener.

addEventListener

back to summary

public void addEventListener(EventListener listener)

Implements org.mortbay.jetty.SessionManager.addEventListener.

Doc from org.mortbay.jetty.SessionManager.addEventListener.

Adds an event listener for session-related events.

Parameters

listener:EventListener: the session event listener to add Individual SessionManagers implementations may accept arbitrary listener types, but they are expected to at least handle HttpSessionActivationListener, HttpSessionAttributeListener, HttpSessionBindingListener and HttpSessionListener.

addSession	back to summary
protected abstract void addSession(AbstractSessionManager.Session session)

addSession	back to summary
protected void addSession(AbstractSessionManager.Session session, boolean created) Add the session Registers the session with this manager and registers the session ID with the sessionIDManager;

clearEventListeners	back to summary
public void clearEventListeners() Implements org.mortbay.jetty.SessionManager.clearEventListeners. Doc from org.mortbay.jetty.SessionManager.clearEventListeners. Removes all event listeners for session-related events.

clearEventListeners

back to summary

public void clearEventListeners()

Implements org.mortbay.jetty.SessionManager.clearEventListeners.

Doc from org.mortbay.jetty.SessionManager.clearEventListeners.

Removes all event listeners for session-related events.

complete back to summary

complete	back to summary
public void complete(HttpSession session) Implements org.mortbay.jetty.SessionManager.complete. Doc from org.mortbay.jetty.SessionManager.complete. Called by the `SessionHandler` when a session is last accessed by a request. Parameters session:HttpSession the session object

public void complete(HttpSession session)

Implements org.mortbay.jetty.SessionManager.complete.

Doc from org.mortbay.jetty.SessionManager.complete.

Called by the SessionHandler when a session is last accessed by a request.

Parameters

session:HttpSession: the session object

doStart	back to summary
public void doStart() throws Exception Overrides org.mortbay.component.AbstractLifeCycle.doStart.

doStop	back to summary
public void doStop() throws Exception Overrides org.mortbay.component.AbstractLifeCycle.doStop.

getClusterId	back to summary
public String getClusterId(HttpSession session) Implements org.mortbay.jetty.SessionManager.getClusterId. Parameters session:HttpSession Doc from org.mortbay.jetty.SessionManager.getClusterId. the session object Returns:String Doc from org.mortbay.jetty.SessionManager.getClusterId. the unique id of the session within the cluster (without a node id extension)

getClusterId

back to summary

public String getClusterId(HttpSession session)

Implements org.mortbay.jetty.SessionManager.getClusterId.

Parameters

session:HttpSession

Doc from org.mortbay.jetty.SessionManager.getClusterId.

the session object

Returns:String

Doc from org.mortbay.jetty.SessionManager.getClusterId.

the unique id of the session within the cluster (without a node id extension)

getHttpOnly	back to summary
public boolean getHttpOnly() Implements org.mortbay.jetty.SessionManager.getHttpOnly. Returns:boolean Returns the httpOnly.

getHttpOnly

back to summary

public boolean getHttpOnly()

Implements org.mortbay.jetty.SessionManager.getHttpOnly.

Returns:boolean: Returns the httpOnly.

getHttpSession back to summary

getHttpSession	back to summary
public HttpSession getHttpSession(String nodeId) Implements org.mortbay.jetty.SessionManager.getHttpSession. Doc from org.mortbay.jetty.SessionManager.getHttpSession. Returns the `HttpSession` with the given session id Parameters nodeId:String the session id Returns:HttpSession the `HttpSession` with the corresponding id or null if no session with the given id exists

public HttpSession getHttpSession(String nodeId)

Implements org.mortbay.jetty.SessionManager.getHttpSession.

Doc from org.mortbay.jetty.SessionManager.getHttpSession.

Returns the HttpSession with the given session id

Parameters

nodeId:String: the session id

Returns:HttpSession

the HttpSession with the corresponding id or null if no session with the given id exists

getIdManager	back to summary
public SessionIdManager getIdManager() Implements org.mortbay.jetty.SessionManager.getIdManager. Returns:SessionIdManager Returns the metaManager used for cross context session management

getIdManager

back to summary

public SessionIdManager getIdManager()

Implements org.mortbay.jetty.SessionManager.getIdManager.

Returns:SessionIdManager: Returns the metaManager used for cross context session management

getMaxCookieAge

back to summary

public int getMaxCookieAge()

Implements org.mortbay.jetty.SessionManager.getMaxCookieAge.

Returns:int

Doc from org.mortbay.jetty.SessionManager.getMaxCookieAge.

the max age to set on the session cookie, in seconds

getMaxInactiveInterval	back to summary
public int getMaxInactiveInterval() Implements org.mortbay.jetty.SessionManager.getMaxInactiveInterval. Returns:int seconds

getMaxInactiveInterval

back to summary

public int getMaxInactiveInterval()

Implements org.mortbay.jetty.SessionManager.getMaxInactiveInterval.

Returns:int: seconds

getMaxSessions	back to summary
public int getMaxSessions()

getMetaManager back to summary

getMetaManager	back to summary
public SessionIdManager getMetaManager() Implements org.mortbay.jetty.SessionManager.getMetaManager. Deprecated use `getIdManager()` Returns:SessionIdManager Doc from org.mortbay.jetty.SessionManager.getMetaManager. the cross context session id manager.

public SessionIdManager getMetaManager()

Implements org.mortbay.jetty.SessionManager.getMetaManager.

Deprecated

use getIdManager()

Returns:SessionIdManager

Doc from org.mortbay.jetty.SessionManager.getMetaManager.

the cross context session id manager.

getMinSessions	back to summary
public int getMinSessions()

getNodeId	back to summary
public String getNodeId(HttpSession session) Implements org.mortbay.jetty.SessionManager.getNodeId. Parameters session:HttpSession Doc from org.mortbay.jetty.SessionManager.getNodeId. the session object Returns:String Doc from org.mortbay.jetty.SessionManager.getNodeId. the unique id of the session within the cluster, extended with an optional node id.

getNodeId

back to summary

public String getNodeId(HttpSession session)

Implements org.mortbay.jetty.SessionManager.getNodeId.

Parameters

session:HttpSession

Doc from org.mortbay.jetty.SessionManager.getNodeId.

the session object

Returns:String

Doc from org.mortbay.jetty.SessionManager.getNodeId.

the unique id of the session within the cluster, extended with an optional node id.

getRefreshCookieAge	back to summary
public int getRefreshCookieAge()

getSecureCookies

back to summary

public boolean getSecureCookies()

Implements org.mortbay.jetty.SessionManager.getSecureCookies.

Returns:boolean: Returns the secureCookies.

getSession	back to summary
public abstract AbstractSessionManager.Session getSession(String idInCluster) Get a known existingsession Parameters idInCluster:String The session ID in the cluster, stripped of any worker name. Returns:AbstractSessionManager.Session A Session or null if none exists.

getSession

back to summary

public abstract AbstractSessionManager.Session getSession(String idInCluster)

Get a known existingsession

Parameters

idInCluster:String: The session ID in the cluster, stripped of any worker name.

Returns:AbstractSessionManager.Session

A Session or null if none exists.

getSessionCookie

back to summary

public String getSessionCookie()

Implements org.mortbay.jetty.SessionManager.getSessionCookie.

Returns:String

Doc from org.mortbay.jetty.SessionManager.getSessionCookie.

the session cookie name, by default "JSESSIONID".

getSessionCookie back to summary

public Cookie getSessionCookie(HttpSession session, String contextPath, boolean requestIsSecure)

Implements org.mortbay.jetty.SessionManager.getSessionCookie.

Doc from org.mortbay.jetty.SessionManager.getSessionCookie.

Gets a Cookie for a session.

Parameters

session:HttpSession: the session to which the cookie should refer.
contextPath:String: the context to which the cookie should be linked. The client will only send the cookie value when requesting resources under this path.
requestIsSecure:boolean: whether the client is accessing the server over a secure protocol (i.e. HTTPS).

Returns:Cookie

if this SessionManager uses cookies, then this method will return a new cookie object that should be set on the client in order to link future HTTP requests with the session. If cookies are not in use, this method returns null.

getSessionDomain

back to summary

public String getSessionDomain()

Implements org.mortbay.jetty.SessionManager.getSessionDomain.

Returns:String

Doc from org.mortbay.jetty.SessionManager.getSessionDomain.

the domain to set on the session cookie

getSessionHandler	back to summary
public SessionHandler getSessionHandler() Returns:SessionHandler Returns the sessionHandler.

getSessionIdPathParameterName

back to summary

public String getSessionIdPathParameterName()

Implements org.mortbay.jetty.SessionManager.getSessionIdPathParameterName.

Returns:String

Doc from org.mortbay.jetty.SessionManager.getSessionIdPathParameterName.

the URL path parameter name for session id URL rewriting, by default "jsessionid".

getSessionIdPathParameterNamePrefix back to summary

public String getSessionIdPathParameterNamePrefix()

Implements org.mortbay.jetty.SessionManager.getSessionIdPathParameterNamePrefix.

Returns:String

Doc from org.mortbay.jetty.SessionManager.getSessionIdPathParameterNamePrefix.

a formatted version of getSessionIdPathParameterName(), by default ";" + sessionIdParameterName + "=", for easier lookup in URL strings.

getSessionMap	back to summary
public abstract Map<K, V> getSessionMap() Deprecated Need to review if it is needed.

getSessionPath

back to summary

public String getSessionPath()

Implements org.mortbay.jetty.SessionManager.getSessionPath.

Returns:String

Doc from org.mortbay.jetty.SessionManager.getSessionPath.

the path to set on the session cookie

getSessions	back to summary
public abstract int getSessions()

invalidateSessions	back to summary
protected abstract void invalidateSessions()

isNodeIdInSessionId	back to summary
public boolean isNodeIdInSessionId() Returns:boolean true if the cluster node id (worker id) is returned as part of the session id by `HttpSession#getId()`. Default is false.

isUsingCookies

back to summary

public boolean isUsingCookies()

Implements org.mortbay.jetty.SessionManager.isUsingCookies.

Returns:boolean: Returns the usingCookies.

isValid

back to summary

public boolean isValid(HttpSession session)

Implements org.mortbay.jetty.SessionManager.isValid.

Parameters

session:HttpSession

Doc from org.mortbay.jetty.SessionManager.isValid.

the session to test for validity

Returns:boolean

Doc from org.mortbay.jetty.SessionManager.isValid.

whether the given session is valid, that is, it has not been invalidated.

newHttpSession back to summary

public HttpSession newHttpSession(HttpServletRequest request)

Implements org.mortbay.jetty.SessionManager.newHttpSession.

Create a new HttpSession for a request

Parameters

request:HttpServletRequest

Doc from org.mortbay.jetty.SessionManager.newHttpSession.

the HttpServletRequest containing the requested session id

Returns:HttpSession

Doc from org.mortbay.jetty.SessionManager.newHttpSession.

the new HttpSession

newSession	back to summary
protected abstract AbstractSessionManager.Session newSession(HttpServletRequest request) Create a new session instance

removeEventListener

back to summary

public void removeEventListener(EventListener listener)

Implements org.mortbay.jetty.SessionManager.removeEventListener.

Doc from org.mortbay.jetty.SessionManager.removeEventListener.

Removes an event listener for for session-related events.

Parameters

listener:EventListener: the session event listener to remove

removeSession back to summary

public void removeSession(HttpSession session, boolean invalidate)

Remove session from manager

Parameters

session:HttpSession: The session to remove
invalidate:boolean: True if HttpSessionListener#sessionDestroyed(HttpSessionEvent) and SessionIdManager#invalidateAll(String) should be called.

removeSession back to summary

public void removeSession(AbstractSessionManager.Session session, boolean invalidate)

Remove session from manager

Parameters

session:AbstractSessionManager.Session: The session to remove
invalidate:boolean: True if HttpSessionListener#sessionDestroyed(HttpSessionEvent) and SessionIdManager#invalidateAll(String) should be called.

removeSession	back to summary
protected abstract void removeSession(String idInCluster)

resetStats	back to summary
public void resetStats()

setHttpOnly	back to summary
public void setHttpOnly(boolean httpOnly) Parameters httpOnly:boolean The httpOnly to set.

setIdManager

back to summary

public void setIdManager(SessionIdManager metaManager)

Implements org.mortbay.jetty.SessionManager.setIdManager.

Doc from org.mortbay.jetty.SessionManager.setIdManager.

Sets the cross context session id manager

Parameters

metaManager:SessionIdManager: The metaManager used for cross context session management.

setMaxCookieAge

back to summary

public void setMaxCookieAge(int maxCookieAgeInSeconds)

Implements org.mortbay.jetty.SessionManager.setMaxCookieAge.

Doc from org.mortbay.jetty.SessionManager.setMaxCookieAge.

Sets the max age to set on the session cookie, in seconds

Parameters

maxCookieAgeInSeconds:int: the max age to set on the session cookie, in seconds

setMaxInactiveInterval

back to summary

public void setMaxInactiveInterval(int seconds)

Implements org.mortbay.jetty.SessionManager.setMaxInactiveInterval.

Doc from org.mortbay.jetty.SessionManager.setMaxInactiveInterval.

Sets the max period of inactivity, after which the session is invalidated, in seconds.

setMetaManager	back to summary
public void setMetaManager(SessionIdManager metaManager) Deprecated use `setIdManager(SessionIdManager)`

setNodeIdInSessionId	back to summary
public void setNodeIdInSessionId(boolean nodeIdInSessionId) Parameters nodeIdInSessionId:boolean true if the cluster node id (worker id) will be returned as part of the session id by `HttpSession#getId()`. Default is false.

setRefreshCookieAge	back to summary
public void setRefreshCookieAge(int ageInSeconds)

setSecureCookies	back to summary
public void setSecureCookies(boolean secureCookies) Parameters secureCookies:boolean The secureCookies to set.

setSessionCookie

back to summary

public void setSessionCookie(String cookieName)

Implements org.mortbay.jetty.SessionManager.setSessionCookie.

Doc from org.mortbay.jetty.SessionManager.setSessionCookie.

Sets the session cookie name.

Parameters

cookieName:String: the session cookie name

setSessionDomain

back to summary

public void setSessionDomain(String domain)

Implements org.mortbay.jetty.SessionManager.setSessionDomain.

Doc from org.mortbay.jetty.SessionManager.setSessionDomain.

Sets the domain to set on the session cookie

Parameters

domain:String: the domain to set on the session cookie

setSessionHandler back to summary

public void setSessionHandler(SessionHandler sessionHandler)

Implements org.mortbay.jetty.SessionManager.setSessionHandler.

Doc from org.mortbay.jetty.SessionManager.setSessionHandler.

Sets the SessionHandler.

Parameters

sessionHandler:SessionHandler: The sessionHandler to set.

setSessionIdPathParameterName

back to summary

public void setSessionIdPathParameterName(String param)

Implements org.mortbay.jetty.SessionManager.setSessionIdPathParameterName.

Doc from org.mortbay.jetty.SessionManager.setSessionIdPathParameterName.

Sets the session id URL path parameter name.

Parameters

param:String: the URL path parameter name for session id URL rewriting (null or "none" for no rewriting).

setSessionPath

back to summary

public void setSessionPath(String path)

Implements org.mortbay.jetty.SessionManager.setSessionPath.

Doc from org.mortbay.jetty.SessionManager.setSessionPath.

Sets the path to set on the session cookie

Parameters

path:String: the path to set on the session cookie

setUsingCookies	back to summary
public void setUsingCookies(boolean usingCookies) Parameters usingCookies:boolean The usingCookies to set.

org.mortbay.jetty.servlet back to summary

public Class AbstractSessionManager.NullSessionContext

Class Inheritance

extends Object
implements HttpSessionContext

java.lang.Object
org.mortbay.jetty.servlet.AbstractSessionManager.NullSessionContext

All Implemented Interfaces

javax.servlet.http.HttpSessionContext

Deprecated

as a consequence of HttpSessionContext being deprecated. See corresponding docs for further information.

Null returning implementation of HttpSessionContext

Author: Greg Wilkins (gregw)

Constructor Summary

Access	Constructor and Description
private	NullSessionContext()

Method Summary

Modifier and Type	Method and Description
public Enumeration<E>	getIds() Implements javax.servlet.http.HttpSessionContext.getIds. Deprecated From HttpSessionContext
public HttpSession	getSession(String the id of the session to be returned id) Implements javax.servlet.http.HttpSessionContext.getSession. Deprecated From HttpSessionContext

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

Constructor Detail

NullSessionContext	back to summary
private NullSessionContext()

Method Detail

getIds

back to summary

public Enumeration<E> getIds()

Implements javax.servlet.http.HttpSessionContext.getIds.

Deprecated

From HttpSessionContext

Returns:Enumeration<E>

Doc from javax.servlet.http.HttpSessionContext.getIds.

null

getSession

back to summary

public HttpSession getSession(String id)

Implements javax.servlet.http.HttpSessionContext.getSession.

Deprecated

From HttpSessionContext

Parameters

id:String

Doc from javax.servlet.http.HttpSessionContext.getSession.

the id of the session to be returned

Returns:HttpSession

Doc from javax.servlet.http.HttpSessionContext.getSession.

null in all cases

org.mortbay.jetty.servlet back to summary

public abstract Class AbstractSessionManager.Session

Class Inheritance

extends Object
implements SessionIf, Serializable

java.lang.Object
org.mortbay.jetty.servlet.AbstractSessionManager.Session

All Implemented Interfaces

java.io.Serializable, org.mortbay.jetty.servlet.AbstractSessionManager.SessionIf, javax.servlet.http.HttpSession

Known Direct Subclasses

org.mortbay.jetty.servlet.HashSessionManager.Session, org.mortbay.jetty.servlet.JDBCSessionManager.Session

Implements javax.servlet.HttpSession from the javax.servlet package.

Author: gregw

Field Summary

Modifier and Type	Field and Description
protected long	_accessed
protected final String	_clusterId
protected long	_cookieSet
protected final long	_created
protected boolean	_doInvalidate
protected boolean	_idChanged
protected boolean	_invalid
protected long	_lastAccessed
protected long	_maxIdleMs
protected boolean	_newSession
protected final String	_nodeId
protected int	_requests
protected Map<K, V>	_values

Constructor Summary

Access	Constructor and Description
protected	Session(HttpServletRequest request)
protected	Session(long created, String clusterId)

Method Summary

Modifier and Type	Method and Description
protected void	access(long time)
protected void	bindValue(String name, Object value) If value implements HttpSessionBindingListener, call valueBound()
protected void	complete()
protected void	cookieSet()
protected void	didActivate()
protected void	doInvalidate()
public Object	getAttribute(String a string specifying the name of the object name) Implements javax.servlet.http.HttpSession.getAttribute. Returns the object bound with the specified name in this session, or `null` if no object is bound under the name.
public Enumeration<E>	getAttributeNames() Implements javax.servlet.http.HttpSession.getAttributeNames. Returns an `Enumeration` of `String` objects containing the names of all the objects bound to this session.
protected String	getClusterId()
public long	getCookieSetTime()
public long	getCreationTime() Implements javax.servlet.http.HttpSession.getCreationTime. Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
public String	getId() Implements javax.servlet.http.HttpSession.getId. Returns a string containing the unique identifier assigned to this session.
public long	getLastAccessedTime() Implements javax.servlet.http.HttpSession.getLastAccessedTime. Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.
public int	getMaxInactiveInterval() Implements javax.servlet.http.HttpSession.getMaxInactiveInterval. Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.
protected String	getNodeId()
public ServletContext	getServletContext() Implements javax.servlet.http.HttpSession.getServletContext. Returns the ServletContext to which this session belongs.
public AbstractSessionManager.Session	getSession() Implements org.mortbay.jetty.servlet.AbstractSessionManager.SessionIf.getSession.
public HttpSessionContext	getSessionContext() Implements javax.servlet.http.HttpSession.getSessionContext. Deprecated
public Object	getValue(String a string specifying the name of the object name) Implements javax.servlet.http.HttpSession.getValue. Deprecated As of Version 2.2, this method is replaced by `getAttribute`
public String[]	getValueNames() Implements javax.servlet.http.HttpSession.getValueNames. Deprecated As of Version 2.2, this method is replaced by `getAttributeNames`
protected void	initValues()
public void	invalidate() Implements javax.servlet.http.HttpSession.invalidate. Invalidates this session then unbinds any objects bound to it.
public boolean	isIdChanged()
public boolean	isNew() Implements javax.servlet.http.HttpSession.isNew. Returns `true` if the client does not yet know about the session or if the client chooses not to join the session.
protected boolean	isValid()
protected abstract Map<K, V>	newAttributeMap()
public void	putValue(String the name to which the object is bound; cannot be null name, Object the object to be bound; cannot be null value) Implements javax.servlet.http.HttpSession.putValue. Deprecated As of Version 2.2, this method is replaced by `setAttribute`
public void	removeAttribute(String the name of the object to remove from this session name) Implements javax.servlet.http.HttpSession.removeAttribute. Removes the object bound with the specified name from this session.
public void	removeValue(String the name of the object to remove from this session name) Implements javax.servlet.http.HttpSession.removeValue. Deprecated As of Version 2.2, this method is replaced by `removeAttribute`
public void	setAttribute(String the name to which the object is bound; cannot be null name, Object the object to be bound value) Implements javax.servlet.http.HttpSession.setAttribute. Binds an object to this session, using the name specified.
public void	setIdChanged(boolean changed)
public void	setMaxInactiveInterval(int An integer specifying the number of seconds secs) Implements javax.servlet.http.HttpSession.setMaxInactiveInterval. Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
protected void	timeout()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected void	unbindValue(String name, Object value) If value implements HttpSessionBindingListener, call valueUnbound()
protected void	willPassivate()

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

Field Detail

_accessed	back to summary
protected long _accessed

_clusterId	back to summary
protected final String _clusterId

_cookieSet	back to summary
protected long _cookieSet

_created	back to summary
protected final long _created

_doInvalidate	back to summary
protected boolean _doInvalidate

_idChanged	back to summary
protected boolean _idChanged

_invalid	back to summary
protected boolean _invalid

_lastAccessed	back to summary
protected long _lastAccessed

_maxIdleMs	back to summary
protected long _maxIdleMs

_newSession	back to summary
protected boolean _newSession

_nodeId	back to summary
protected final String _nodeId

_requests	back to summary
protected int _requests

_values	back to summary
protected Map<K, V> _values

Constructor Detail

Session	back to summary
protected Session(HttpServletRequest request)

Session	back to summary
protected Session(long created, String clusterId)

Method Detail

access	back to summary
protected void access(long time)

bindValue	back to summary
protected void bindValue(String name, Object value) If value implements HttpSessionBindingListener, call valueBound()

complete	back to summary
protected void complete()

cookieSet	back to summary
protected void cookieSet()

didActivate	back to summary
protected void didActivate()

doInvalidate	back to summary
protected void doInvalidate() throws IllegalStateException

getAttribute back to summary

public Object getAttribute(String name)

Implements javax.servlet.http.HttpSession.getAttribute.

Doc from javax.servlet.http.HttpSession.getAttribute.

Returns the object bound with the specified name in this session, or null if no object is bound under the name.

Parameters

name:String: a string specifying the name of the object

Returns:Object

the object with the specified name

getAttributeNames back to summary

public Enumeration<E> getAttributeNames()

Implements javax.servlet.http.HttpSession.getAttributeNames.

Doc from javax.servlet.http.HttpSession.getAttributeNames.

Returns an Enumeration of String objects containing the names of all the objects bound to this session.

Returns:Enumeration<E>: an Enumeration of String objects specifying the names of all the objects bound to this session

getClusterId	back to summary
protected String getClusterId()

getCookieSetTime	back to summary
public long getCookieSetTime()

getCreationTime back to summary

public long getCreationTime() throws IllegalStateException

Implements javax.servlet.http.HttpSession.getCreationTime.

Doc from javax.servlet.http.HttpSession.getCreationTime.

Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.

Returns:long

a long specifying when this session was created, expressed in milliseconds since 1/1/1970 GMT

Exceptions

IllegalStateException:: if this method is called on an invalidated session

getId

back to summary

public String getId() throws IllegalStateException

Implements javax.servlet.http.HttpSession.getId.

Doc from javax.servlet.http.HttpSession.getId.

Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the servlet container and is implementation dependent.

Returns:String: a string specifying the identifier assigned to this session

getLastAccessedTime back to summary

public long getLastAccessedTime() throws IllegalStateException

Implements javax.servlet.http.HttpSession.getLastAccessedTime.

Doc from javax.servlet.http.HttpSession.getLastAccessedTime.

Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.

Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.

Returns:long

a long representing the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT

Exceptions

IllegalStateException:: if this method is called on an invalidated session

getMaxInactiveInterval back to summary

public int getMaxInactiveInterval()

Implements javax.servlet.http.HttpSession.getMaxInactiveInterval.

Doc from javax.servlet.http.HttpSession.getMaxInactiveInterval.

Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses. After this interval, the servlet container will invalidate the session. The maximum time interval can be set with the setMaxInactiveInterval method.

A return value of zero or less indicates that the session will never timeout.

Returns:int: an integer specifying the number of seconds this session remains open between client requests

getNodeId	back to summary
protected String getNodeId()

getServletContext

back to summary

public ServletContext getServletContext()

Implements javax.servlet.http.HttpSession.getServletContext.

Doc from javax.servlet.http.HttpSession.getServletContext.

Returns the ServletContext to which this session belongs.

Returns:ServletContext: The ServletContext object for the web application

getSession	back to summary
public AbstractSessionManager.Session getSession() Implements org.mortbay.jetty.servlet.AbstractSessionManager.SessionIf.getSession.

getSessionContext back to summary

public HttpSessionContext getSessionContext() throws IllegalStateException

Implements javax.servlet.http.HttpSession.getSessionContext.

Deprecated

Returns:HttpSessionContext

Doc from javax.servlet.http.HttpSession.getSessionContext.

the HttpSessionContext for this session.

getValue back to summary

public Object getValue(String name) throws IllegalStateException

Implements javax.servlet.http.HttpSession.getValue.

Deprecated

As of Version 2.2, this method is replaced by getAttribute

Parameters

name:String

Doc from javax.servlet.http.HttpSession.getValue.

a string specifying the name of the object

Returns:Object

Doc from javax.servlet.http.HttpSession.getValue.

the object with the specified name

Exceptions

IllegalStateException:

Doc from javax.servlet.http.HttpSession.getValue.

if this method is called on an invalidated session

getValueNames back to summary

public String[] getValueNames() throws IllegalStateException

Implements javax.servlet.http.HttpSession.getValueNames.

Deprecated

As of Version 2.2, this method is replaced by getAttributeNames

Returns:String[]

Doc from javax.servlet.http.HttpSession.getValueNames.

an array of String objects specifying the names of all the objects bound to this session

Exceptions

IllegalStateException:

Doc from javax.servlet.http.HttpSession.getValueNames.

if this method is called on an invalidated session

initValues	back to summary
protected void initValues()

invalidate

back to summary

public void invalidate() throws IllegalStateException

Implements javax.servlet.http.HttpSession.invalidate.

Doc from javax.servlet.http.HttpSession.invalidate.

Invalidates this session then unbinds any objects bound to it.

Exceptions

IllegalStateException:: if this method is called on an already invalidated session

isIdChanged	back to summary
public boolean isIdChanged()

isNew back to summary

public boolean isNew() throws IllegalStateException

Implements javax.servlet.http.HttpSession.isNew.

Doc from javax.servlet.http.HttpSession.isNew.

Returns true if the client does not yet know about the session or if the client chooses not to join the session. For example, if the server used only cookie-based sessions, and the client had disabled the use of cookies, then a session would be new on each request.

Returns:boolean

true if the server has created a session, but the client has not yet joined

Exceptions

IllegalStateException:: if this method is called on an already invalidated session

isValid	back to summary
protected boolean isValid()

newAttributeMap	back to summary
protected abstract Map<K, V> newAttributeMap()

putValue back to summary

public void putValue(String name, Object value) throws IllegalStateException

Implements javax.servlet.http.HttpSession.putValue.

Deprecated

As of Version 2.2, this method is replaced by setAttribute

Parameters

name:String

Doc from javax.servlet.http.HttpSession.putValue.

the name to which the object is bound; cannot be null

value:Object

Doc from javax.servlet.http.HttpSession.putValue.

the object to be bound; cannot be null

Exceptions

IllegalStateException:

Doc from javax.servlet.http.HttpSession.putValue.

if this method is called on an invalidated session

removeAttribute back to summary

public void removeAttribute(String name)

Implements javax.servlet.http.HttpSession.removeAttribute.

Doc from javax.servlet.http.HttpSession.removeAttribute.

Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.

After this method executes, and if the object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueUnbound. The container then notifies any HttpSessionAttributeListeners in the web application.

Parameters

name:String: the name of the object to remove from this session

removeValue back to summary

public void removeValue(String name) throws IllegalStateException

Implements javax.servlet.http.HttpSession.removeValue.

Deprecated

As of Version 2.2, this method is replaced by removeAttribute

Parameters

name:String

Doc from javax.servlet.http.HttpSession.removeValue.

the name of the object to remove from this session

Exceptions

IllegalStateException:

Doc from javax.servlet.http.HttpSession.removeValue.

if this method is called on an invalidated session

setAttribute back to summary

public void setAttribute(String name, Object value)

Implements javax.servlet.http.HttpSession.setAttribute.

Doc from javax.servlet.http.HttpSession.setAttribute.

Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

After this method executes, and if the new object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueBound. The container then notifies any HttpSessionAttributeListeners in the web application.

If an object was already bound to this session of this name that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called.

If the value passed in is null, this has the same effect as calling removeAttribute().

Parameters

name:String: the name to which the object is bound; cannot be null
value:Object: the object to be bound

setIdChanged	back to summary
public void setIdChanged(boolean changed)

setMaxInactiveInterval back to summary

public void setMaxInactiveInterval(int secs)

Implements javax.servlet.http.HttpSession.setMaxInactiveInterval.

Doc from javax.servlet.http.HttpSession.setMaxInactiveInterval.

Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.

An interval value of zero or less indicates that the session should never timeout.

Parameters

secs:int: An integer specifying the number of seconds

timeout	back to summary
protected void timeout() throws IllegalStateException

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.

Returns:String: a string representation of the object

unbindValue	back to summary
protected void unbindValue(String name, Object value) If value implements HttpSessionBindingListener, call valueUnbound()

willPassivate	back to summary
protected void willPassivate()

public abstract Class AbstractSessionManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AbstractSessionManager.NullSessionContext

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public abstract Class AbstractSessionManager.Session

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface AbstractSessionManager.SessionIf

Method Summary

Method Detail