Top Description Inners Fields Constructors Methods
org.mortbay.jetty.servlet

public abstract Class AbstractSessionManager

extends AbstractLifeCycle
implements SessionManager
Class Inheritance
All Implemented Interfaces
org.mortbay.jetty.SessionManager, org.mortbay.component.LifeCycle
Known Direct Subclasses
org.mortbay.jetty.servlet.HashSessionManager, org.mortbay.jetty.servlet.JDBCSessionManager
Imports
java.io.Serializable, java.util.ArrayList, .Collections, .Enumeration, .EventListener, .Iterator, .List, .Map, javax.servlet.ServletContext, javax.servlet.http.Cookie, .HttpServletRequest, .HttpSession, .HttpSessionActivationListener, .HttpSessionAttributeListener, .HttpSessionBindingEvent, .HttpSessionBindingListener, .HttpSessionContext, .HttpSessionEvent, .HttpSessionListener, org.mortbay.component.AbstractLifeCycle, org.mortbay.jetty.Server, .SessionIdManager, .SessionManager, org.mortbay.jetty.handler.ContextHandler, org.mortbay.util.LazyList
An Abstract implementation of SessionManager. The partial implementation of SessionManager interface provides the majority of the handling required to implement a SessionManager. Concrete implementations of SessionManager based on AbstractSessionManager need only implement the newSession method to return a specialized version of the Session inner class that provides an attribute Map.

If the property org.mortbay.jetty.servlet.AbstractSessionManager.23Notifications is set to true, the 2.3 servlet spec notification style will be used.

Author
Greg Wilkins (gregw)

Nested and Inner Type Summary

Modifier and TypeClass 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.

Field Summary

Modifier and TypeField 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

Inherited from org.mortbay.component.AbstractLifeCycle:
_listeners

Constructor Summary

AccessConstructor and Description
public
AbstractSessionManager()

Method Summary

Modifier and TypeMethod 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:
addLifeCycleListenerisFailedisRunningisStartedisStartingisStoppedisStoppingremoveLifeCycleListenerstartstop