Core :: Sessions 12.0.6 · org.eclipse.jetty.session.AbstractSessionManager

Modifier and Type	Class and Description
public static record	AbstractSessionManager.RequestedSession
private class	AbstractSessionManager.SessionStreamWrapper StreamWrapper to intercept commit and complete events to ensure session handling happens in context, with request available.

Modifier and Type	Field and Description
private final Set<String>	_candidateSessionIdsForExpiry
private boolean	_checkingRemoteSessionIdEncoding
private Context	_context
private int	_dftMaxIdleSecs Setting of max inactive interval for new sessions -1 means no timeout
private ClassLoader	_loader
private boolean	_ownScheduler
private int	_refreshCookieAge
private Scheduler	_scheduler
private boolean	_secureRequestOnly
private SessionCache	_sessionCache
private SessionContext	_sessionContext
private String	_sessionCookie
private final Map<String, String>	_sessionCookieAttributes
private Map<String, String>	_sessionCookieSecureAttributes
private SessionIdManager	_sessionIdManager
private String	_sessionIdPathParameterName
private String	_sessionIdPathParameterNamePrefix
private List<Session.LifeCycleListener>	_sessionLifeCycleListeners
private final CounterStatistic	_sessionsCreatedStats
private final SampleStatistic	_sessionTimeStats
private boolean	_usingCookies
private boolean	_usingUriParameters
pack-priv static final Logger	LOG Hides org.eclipse.jetty.util.component.ContainerLifeCycle.LOG.
private static final AbstractSessionManager.RequestedSession	NO_REQUESTED_SESSION

Access	Constructor and Description
public	AbstractSessionManager()

Method Summary

Modifier and Type	Method and Description
public HttpCookie	Returns: 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. access(ManagedSession the session object session, boolean whether the request is secure or not secure) Called when a session is first accessed by request processing.
protected void	addSessionStreamWrapper(Request request)
public long	Returns: the time remaining before expiry or inactivity timeout calculateInactivityTimeout(String the ID of the session id, long The time in milliseconds remaining before this session is considered Idle timeRemainingMs, long The maximum time in milliseconds that a session may be idle. maxInactiveMs) Implements org.eclipse.jetty.session.SessionManager.calculateInactivityTimeout. Calculate what the session timer setting should be based on: the time remaining before the session expires and any idle eviction time configured.
public void	commit(ManagedSession session) Implements org.eclipse.jetty.session.SessionManager.commit. Called when a response is about to be committed.
public void	complete(ManagedSession the session object session) Implements org.eclipse.jetty.session.SessionManager.complete. Called when a request is finally leaving a session.
public void	doStart() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added.
protected void	doStop() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added.
private static String	duplicateSession(String id0, boolean valid0, boolean cookie0, String id1, boolean valid1, boolean cookie1)
public String	encodeURI(Request request, String uri, boolean cookiesInUse) Implements org.eclipse.jetty.session.SessionManager.encodeURI.
public Context	getContext() Implements org.eclipse.jetty.session.SessionManager.getContext.
public ManagedSession	Returns: the Session matching the id or null if none exists getManagedSession(String The session id, possibly imcluding worker name suffix. extendedId) Implements org.eclipse.jetty.session.SessionManager.getManagedSession. Get a known existing session
public int	getMaxCookieAge() Implements org.eclipse.jetty.session.SessionConfig.getMaxCookieAge.
public int	Returns: the max period of inactivity, after which the session is invalidated, in seconds. If less than or equal to zero, then the session is immortal getMaxInactiveInterval() Implements org.eclipse.jetty.session.SessionConfig.getMaxInactiveInterval.
public int	getRefreshCookieAge() Implements org.eclipse.jetty.session.SessionConfig.getRefreshCookieAge.
public HttpCookie.SameSite	getSameSite() Implements org.eclipse.jetty.session.SessionConfig.getSameSite.
public abstract Server	getServer()
public SessionCache	Returns: the session cache getSessionCache() Implements org.eclipse.jetty.session.SessionManager.getSessionCache.
public String	getSessionComment() Implements org.eclipse.jetty.session.SessionConfig.getSessionComment.
public SessionContext	getSessionContext()
public String	getSessionCookie() Implements org.eclipse.jetty.session.SessionConfig.getSessionCookie.
public HttpCookie	Returns: 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`. getSessionCookie(ManagedSession the session to which the cookie should refer. session, boolean whether the client is accessing the server over a secure protocol (i.e. HTTPS). requestIsSecure) Implements org.eclipse.jetty.session.SessionManager.getSessionCookie. A session cookie is marked as secure IFF any of the following conditions are true: SessionCookieConfig.setSecure == true SessionCookieConfig.setSecure == false && _secureRequestOnly==true && request is HTTPS
public String	getSessionCookieAttribute(String name)
public Map<String, String>	Returns: all of the cookie config attributes EXCEPT for those that have explicit setter/getters getSessionCookieAttributes()
public String	getSessionDomain() Implements org.eclipse.jetty.session.SessionConfig.getSessionDomain.
public SessionIdManager	getSessionIdManager() Implements org.eclipse.jetty.session.SessionManager.getSessionIdManager.
public String	Returns: the URL path parameter name for session id URL rewriting, by default "jsessionid". getSessionIdPathParameterName() Implements org.eclipse.jetty.session.SessionConfig.getSessionIdPathParameterName.
public String	Returns: a formatted version of `getSessionIdPathParameterName()`, by default ";" + sessionIdParameterName + "=", for easier lookup in URL strings. getSessionIdPathParameterNamePrefix() Implements org.eclipse.jetty.session.SessionConfig.getSessionIdPathParameterNamePrefix.
public String	getSessionPath() Implements org.eclipse.jetty.session.SessionConfig.getSessionPath.
public int	getSessionsCreated() Implements org.eclipse.jetty.session.SessionManager.getSessionsCreated.
public double	Returns: mean amount of time session remained valid getSessionTimeMean() Implements org.eclipse.jetty.session.SessionManager.getSessionTimeMean.
public double	Returns: standard deviation of amount of time session remained valid getSessionTimeStdDev() Implements org.eclipse.jetty.session.SessionManager.getSessionTimeStdDev.
public long	Returns: total amount of time all sessions remained valid getSessionTimeTotal() Implements org.eclipse.jetty.session.SessionManager.getSessionTimeTotal.
public void	invalidate(String the session id to invalidate id) Implements org.eclipse.jetty.session.SessionManager.invalidate. Called by SessionIdManager to remove a session that has been invalidated, either by this context or another context.
public boolean	Returns: True if absolute URLs are check for remoteness before being session encoded. isCheckingRemoteSessionIdEncoding() Implements org.eclipse.jetty.session.SessionConfig.isCheckingRemoteSessionIdEncoding.
public boolean	Returns: true if session cookies should be HTTP only isHttpOnly() Implements org.eclipse.jetty.session.SessionConfig.isHttpOnly.
public boolean	Returns: `true` if this manager knows about this id isIdInUse(String identity of session to check id) Implements org.eclipse.jetty.session.SessionManager.isIdInUse. Check if id is in use by this context
public boolean	Returns: true if session cookies should have the `Partitioned` attribute isPartitioned() Implements org.eclipse.jetty.session.SessionConfig.isPartitioned.
public boolean	Returns: same as SessionCookieConfig.getSecure(). If true, session cookies are ALWAYS marked as secure. If false, a session cookie is ONLY marked as secure if _secureRequestOnly == true and it is an HTTPS request. isSecureCookies() Implements org.eclipse.jetty.session.SessionConfig.isSecureCookies.
public boolean	Returns: true if session cookie is to be marked as secure only on HTTPS requests isSecureRequestOnly() Implements org.eclipse.jetty.session.SessionConfig.isSecureRequestOnly.
public boolean	Returns: true if using session cookies is allowed, false otherwise isUsingCookies() Implements org.eclipse.jetty.session.SessionConfig.isUsingCookies.
public boolean	Returns: whether the session management is handled via URLs. isUsingUriParameters() Implements org.eclipse.jetty.session.SessionConfig.isUsingUriParameters.
public boolean	isUsingURLs() Deprecated for removal since 12.0.1. use `isUsingUriParameters()` instead, will be removed in Jetty 12.1.0
public void	newSession(Request the inbound request request, String the session id used by the request requestedSessionId, Consumer<ManagedSession> consumer) Implements org.eclipse.jetty.session.SessionManager.newSession. Create a new Session, using the requested session id if possible.
public SessionInactivityTimer	newSessionInactivityTimer(ManagedSession the session to time session) Implements org.eclipse.jetty.session.SessionManager.newSessionInactivityTimer. Make a new timer for the session.
public void	onSessionCreated(Session session) Overrides default org.eclipse.jetty.session.SessionManager.onSessionCreated.
public void	onSessionDestroyed(Session session) Overrides default org.eclipse.jetty.session.SessionManager.onSessionDestroyed.
public void	onSessionIdChanged(Session session, String oldId) Overrides default org.eclipse.jetty.session.SessionManager.onSessionIdChanged.
public void	recordSessionTime(ManagedSession the session whose time to record session) Implements org.eclipse.jetty.session.SessionManager.recordSessionTime. Record length of time session has been active.
public void	renewSessionId(String the old session id oldId, String the session id including worker suffix oldExtendedId, String the new session id newId, String the new session id including worker suffix newExtendedId) Implements org.eclipse.jetty.session.SessionManager.renewSessionId. Change the existing session id.
protected AbstractSessionManager.RequestedSession	resolveRequestedSessionId(Request The request from which to obtain the ID request) Find any Session associated with the Request.
public void	scavenge() Implements org.eclipse.jetty.session.SessionManager.scavenge. Called periodically by the HouseKeeper to handle the list of sessions that have expired since the last call to scavenge.
private void	secureRequestOnlyAttributes()
public void	sessionTimerExpired(ManagedSession the session session, long the time at which to check for expiry now) Implements org.eclipse.jetty.session.SessionManager.sessionTimerExpired. Each session has a timer that is configured to go off when either the session has not been accessed for a configurable amount of time, or the session itself has passed its expiry.
public void	setCheckingRemoteSessionIdEncoding(boolean True if absolute URLs are check for remoteness before being session encoded. remote) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setCheckingRemoteSessionIdEncoding.
public void	setHttpOnly(boolean True if cookies should be HttpOnly. httpOnly) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setHttpOnly. Set if Session cookies should use HTTP Only
public void	setMaxCookieAge(int maxCookieAge) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setMaxCookieAge.
public void	setMaxInactiveInterval(int the max inactivity period, in seconds. If less than or equal to zero, then the session is immortal seconds) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setMaxInactiveInterval. Sets the max period of inactivity, after which the session is invalidated, in seconds.
public void	setPartitioned(boolean whether session cookies should have the `Partitioned` attribute partitioned) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setPartitioned. Sets whether session cookies should have the `Partitioned` attribute
public void	setRefreshCookieAge(int ageInSeconds) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setRefreshCookieAge.
public void	setSameSite(HttpCookie.SameSite sessionSameSite) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setSameSite.
public void	setSecureCookies(boolean secure) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setSecureCookies.
public void	setSecureRequestOnly(boolean true to set Session Cookie Config as secure secureRequestOnly) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setSecureRequestOnly. HTTPS request.
public void	setSessionCache(SessionCache the SessionCache to use cache) Implements org.eclipse.jetty.session.SessionManager.setSessionCache, org.eclipse.jetty.session.SessionConfig.Mutable.setSessionCache. Set up the SessionCache.
public void	setSessionComment(String sessionComment) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setSessionComment.
public void	setSessionCookie(String cookieName) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setSessionCookie.
public void	setSessionCookieAttribute(String name, String value)
public void	setSessionDomain(String domain) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setSessionDomain.
public void	setSessionIdManager(SessionIdManager The sessionIdManager used for cross context session management. sessionIdManager) Implements org.eclipse.jetty.session.SessionManager.setSessionIdManager, org.eclipse.jetty.session.SessionConfig.Mutable.setSessionIdManager. Set up the SessionIdManager.
public void	setSessionIdPathParameterName(String the URL path parameter name for session id URL rewriting (null or "none" for no rewriting). param) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setSessionIdPathParameterName. Sets the session id URL path parameter name.
public void	setSessionPath(String sessionPath) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setSessionPath.
public void	setUsingCookies(boolean true if cookies are used to track sessions usingCookies) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setUsingCookies.
public void	setUsingUriParameters(boolean usingUriParameters) Implements org.eclipse.jetty.session.SessionConfig.Mutable.setUsingUriParameters.
public void	setUsingURLs(boolean usingURLs) Deprecated for removal since 12.0.1. use `setUsingUriParameters(boolean)` instead, will be removed in Jetty 12.1.0
private void	shutdownSessions() Prepare sessions for session manager shutdown

public abstract Class AbstractSessionManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary