Class SessionHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.ee9.nested.AbstractHandler

org.eclipse.jetty.ee9.nested.AbstractHandlerContainer

org.eclipse.jetty.ee9.nested.HandlerWrapper

org.eclipse.jetty.ee9.nested.ScopedHandler

org.eclipse.jetty.ee9.nested.SessionHandler

All Implemented Interfaces:

Handler, HandlerContainer, SessionConfig, SessionConfig.Mutable, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

public class SessionHandler
extends ScopedHandler
implements SessionConfig.Mutable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	SessionHandler.CookieConfig	CookieConfig Implementation of the jakarta.servlet.SessionCookieConfig.
class	SessionHandler.ServletSessionApi

Nested classes/interfaces inherited from class AbstractHandler

AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Nested classes/interfaces inherited from interface SessionConfig

SessionConfig.Mutable

Field Summary

Fields

Modifier and Type	Field	Description
static final EnumSet<jakarta.servlet.SessionTrackingMode>	DEFAULT_SESSION_TRACKING_MODES

Fields inherited from class ScopedHandler

_nextScope, _outerScope

Fields inherited from class HandlerWrapper

_handler

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

KEY

Fields inherited from interface SessionConfig

__CheckRemoteSessionEncodingProperty, __DefaultSessionCookie, __DefaultSessionDomain, __DefaultSessionIdPathParameterName, __MaxAgeProperty, __SessionCookieProperty, __SessionDomainProperty, __SessionIdPathParameterNameProperty, __SessionPathProperty

Constructor Summary

Constructors

Constructor	Description
SessionHandler()

Method Summary

Modifier and Type	Method	Description
boolean	addEventListener(EventListener listener)	Adds an event listener for session-related events.
protected void	configureCookies()
void	doHandle(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Do the handler work within the scope.
void	doScope(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Scope the handler
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
Set<jakarta.servlet.SessionTrackingMode>	getDefaultSessionTrackingModes()
Set<jakarta.servlet.SessionTrackingMode>	getEffectiveSessionTrackingModes()
int	getMaxCookieAge()
int	getMaxInactiveInterval()
int	getRefreshCookieAge()
HttpCookie.SameSite	getSameSite()
protected List<jakarta.servlet.http.HttpSessionAttributeListener>	getSessionAttributeListeners()
SessionCache	getSessionCache()
String	getSessionComment()
String	getSessionCookie()
jakarta.servlet.SessionCookieConfig	getSessionCookieConfig()
String	getSessionDomain()
protected List<jakarta.servlet.http.HttpSessionIdListener>	getSessionIdListeners()
SessionIdManager	getSessionIdManager()
String	getSessionIdPathParameterName()
String	getSessionIdPathParameterNamePrefix()
protected List<jakarta.servlet.http.HttpSessionListener>	getSessionListeners()
SessionManager	getSessionManager()
String	getSessionPath()
boolean	isCheckingRemoteSessionIdEncoding()
boolean	isHttpOnly()
boolean	isPartitioned()
boolean	isSecureCookies()
boolean	isSecureRequestOnly()
boolean	isUsingCookies()
boolean	isUsingUriParameters()
boolean	removeEventListener(EventListener listener)	Remove an event listener.
void	setCheckingRemoteSessionIdEncoding(boolean value)
void	setHttpOnly(boolean value)
void	setMaxCookieAge(int value)
void	setMaxInactiveInterval(int value)
void	setPartitioned(boolean value)
void	setRefreshCookieAge(int value)
void	setSameSite(HttpCookie.SameSite sameSite)
void	setSecureCookies(boolean value)
void	setSecureRequestOnly(boolean value)
void	setSessionCache(SessionCache cache)
void	setSessionComment(String sessionComment)
void	setSessionCookie(String value)
void	setSessionDomain(String value)
void	setSessionIdManager(SessionIdManager sessionIdManager)
void	setSessionIdPathParameterName(String value)
void	setSessionPath(String value)
void	setSessionTrackingModes(Set<jakarta.servlet.SessionTrackingMode> sessionTrackingModes)
void	setUsingCookies(boolean value)
void	setUsingUriParameters(boolean value)

Methods inherited from class ScopedHandler

handle, nextHandle, nextScope

Methods inherited from class HandlerWrapper

destroy, expandChildren, getHandler, getHandlers, getTail, insertHandler, setAsParent, setHandler

Methods inherited from class AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

Methods inherited from class AbstractHandler

doError, doStop, getServer

Methods inherited from class ContainerLifeCycle

addBean, addBean, addManaged, contains, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

Methods inherited from class Object

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

Methods inherited from interface Container

getCachedBeans, getEventListeners

Methods inherited from interface Dumpable

dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Methods inherited from interface LifeCycle

isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, start, stop

Field Details

DEFAULT_SESSION_TRACKING_MODES

public static final EnumSet<jakarta.servlet.SessionTrackingMode> DEFAULT_SESSION_TRACKING_MODES

Constructor Details

SessionHandler

public SessionHandler()

Method Details

getSessionManager

public SessionManager getSessionManager()

getSessionListeners

protected List<jakarta.servlet.http.HttpSessionListener> getSessionListeners()

getSessionAttributeListeners

protected List<jakarta.servlet.http.HttpSessionAttributeListener> getSessionAttributeListeners()

getSessionIdListeners

protected List<jakarta.servlet.http.HttpSessionIdListener> getSessionIdListeners()

setSessionCache

public void setSessionCache(SessionCache cache)

Specified by:

setSessionCache in interface SessionConfig.Mutable

getSessionCache

public SessionCache getSessionCache()

setSessionIdManager

public void setSessionIdManager(SessionIdManager sessionIdManager)

Specified by:

setSessionIdManager in interface SessionConfig.Mutable

getSessionIdManager

public SessionIdManager getSessionIdManager()

configureCookies

protected void configureCookies()

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class ScopedHandler

Throws:

Exception - If there was a problem starting. Will cause a transition to FAILED state

addEventListener

public boolean addEventListener(EventListener listener)

Adds an event listener for session-related events.

Specified by:

addEventListener in interface Container

Specified by:

addEventListener in interface LifeCycle

Overrides:

addEventListener in class ContainerLifeCycle

Parameters:

listener - 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.

Returns:

true if the listener was added

See Also:

• removeEventListener(EventListener)
• HttpSessionAttributeListener
• HttpSessionListener
• HttpSessionIdListener

removeEventListener

public boolean removeEventListener(EventListener listener)

Description copied from interface: Container

Remove an event listener.

Specified by:

removeEventListener in interface Container

Specified by:

removeEventListener in interface LifeCycle

Overrides:

removeEventListener in class ContainerLifeCycle

Parameters:

listener - the listener to remove

Returns:

true if the listener was removed

See Also:

• Container.removeBean(Object)

getSessionCookieConfig

public jakarta.servlet.SessionCookieConfig getSessionCookieConfig()

getDefaultSessionTrackingModes

public Set<jakarta.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()

getEffectiveSessionTrackingModes

public Set<jakarta.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()

setSessionTrackingModes

public void setSessionTrackingModes(Set<jakarta.servlet.SessionTrackingMode> sessionTrackingModes)

getMaxCookieAge

public int getMaxCookieAge()

Specified by:

getMaxCookieAge in interface SessionConfig

getMaxInactiveInterval

public int getMaxInactiveInterval()

Specified by:

getMaxInactiveInterval in interface SessionConfig

getRefreshCookieAge

public int getRefreshCookieAge()

Specified by:

getRefreshCookieAge in interface SessionConfig

getSameSite

public HttpCookie.SameSite getSameSite()

Specified by:

getSameSite in interface SessionConfig

getSessionComment

public String getSessionComment()

Specified by:

getSessionComment in interface SessionConfig

getSessionCookie

public String getSessionCookie()

Specified by:

getSessionCookie in interface SessionConfig

getSessionDomain

public String getSessionDomain()

Specified by:

getSessionDomain in interface SessionConfig

getSessionIdPathParameterName

public String getSessionIdPathParameterName()

Specified by:

getSessionIdPathParameterName in interface SessionConfig

getSessionIdPathParameterNamePrefix

public String getSessionIdPathParameterNamePrefix()

Specified by:

getSessionIdPathParameterNamePrefix in interface SessionConfig

getSessionPath

public String getSessionPath()

Specified by:

getSessionPath in interface SessionConfig

isCheckingRemoteSessionIdEncoding

public boolean isCheckingRemoteSessionIdEncoding()

Specified by:

isCheckingRemoteSessionIdEncoding in interface SessionConfig

isHttpOnly

public boolean isHttpOnly()

Specified by:

isHttpOnly in interface SessionConfig

isPartitioned

public boolean isPartitioned()

Specified by:

isPartitioned in interface SessionConfig

isSecureCookies

public boolean isSecureCookies()

Specified by:

isSecureCookies in interface SessionConfig

isSecureRequestOnly

public boolean isSecureRequestOnly()

Specified by:

isSecureRequestOnly in interface SessionConfig

isUsingCookies

public boolean isUsingCookies()

Specified by:

isUsingCookies in interface SessionConfig

isUsingUriParameters

public boolean isUsingUriParameters()

Specified by:

isUsingUriParameters in interface SessionConfig

setCheckingRemoteSessionIdEncoding

public void setCheckingRemoteSessionIdEncoding(boolean value)

Specified by:

setCheckingRemoteSessionIdEncoding in interface SessionConfig.Mutable

setHttpOnly

public void setHttpOnly(boolean value)

Specified by:

setHttpOnly in interface SessionConfig.Mutable

setPartitioned

public void setPartitioned(boolean value)

Specified by:

setPartitioned in interface SessionConfig.Mutable

setMaxCookieAge

public void setMaxCookieAge(int value)

Specified by:

setMaxCookieAge in interface SessionConfig.Mutable

setMaxInactiveInterval

public void setMaxInactiveInterval(int value)

Specified by:

setMaxInactiveInterval in interface SessionConfig.Mutable

setRefreshCookieAge

public void setRefreshCookieAge(int value)

Specified by:

setRefreshCookieAge in interface SessionConfig.Mutable

setSameSite

public void setSameSite(HttpCookie.SameSite sameSite)

Specified by:

setSameSite in interface SessionConfig.Mutable

setSecureCookies

public void setSecureCookies(boolean value)

Specified by:

setSecureCookies in interface SessionConfig.Mutable

setSecureRequestOnly

public void setSecureRequestOnly(boolean value)

Specified by:

setSecureRequestOnly in interface SessionConfig.Mutable

setSessionComment

public void setSessionComment(String sessionComment)

Specified by:

setSessionComment in interface SessionConfig.Mutable

setSessionCookie

public void setSessionCookie(String value)

Specified by:

setSessionCookie in interface SessionConfig.Mutable

setSessionDomain

public void setSessionDomain(String value)

Specified by:

setSessionDomain in interface SessionConfig.Mutable

setSessionIdPathParameterName

public void setSessionIdPathParameterName(String value)

Specified by:

setSessionIdPathParameterName in interface SessionConfig.Mutable

setSessionPath

public void setSessionPath(String value)

Specified by:

setSessionPath in interface SessionConfig.Mutable

setUsingCookies

public void setUsingCookies(boolean value)

Specified by:

setUsingCookies in interface SessionConfig.Mutable

setUsingUriParameters

public void setUsingUriParameters(boolean value)

Specified by:

setUsingUriParameters in interface SessionConfig.Mutable

doScope

public void doScope(String target,
 Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
             throws IOException,
jakarta.servlet.ServletException

Description copied from class: ScopedHandler

Scope the handler

Derived implementations should call ScopedHandler.nextScope(String, Request, HttpServletRequest, HttpServletResponse)

Overrides:

doScope in class ScopedHandler

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request.

response - The response as the Response object or a wrapper of that request.

Throws:

IOException - if unable to handle the request or response processing

jakarta.servlet.ServletException - if unable to handle the request or response due to underlying servlet issue

doHandle

public void doHandle(String target,
 Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
              throws IOException,
jakarta.servlet.ServletException

Description copied from class: ScopedHandler

Do the handler work within the scope.

Derived implementations should call ScopedHandler.nextHandle(String, Request, HttpServletRequest, HttpServletResponse)

Specified by:

doHandle in class ScopedHandler

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request.

response - The response as the Response object or a wrapper of that request.

Throws:

IOException - if unable to handle the request or response processing

jakarta.servlet.ServletException - if unable to handle the request or response due to underlying servlet issue