Class SessionHandler
java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.session.AbstractSessionManager
org.eclipse.jetty.session.SessionHandler
- All Implemented Interfaces:
Handler, Handler.Container, Handler.Singleton, Request.Handler, SessionConfig, SessionConfig.Mutable, SessionManager, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, Invocable
A simple core SessionHandler
-
Nested Class Summary
Nested classes/interfaces inherited from class AbstractSessionManager
AbstractSessionManager.RequestedSession
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 Handler
Handler.Abstract, Handler.AbstractContainer, Handler.Collection, Handler.Container, Handler.Sequence, Handler.Singleton, Handler.Wrapper
Nested classes/interfaces inherited from interface Invocable
Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task
Nested classes/interfaces inherited from interface LifeCycle
LifeCycle.Listener
Nested classes/interfaces inherited from interface Request.Handler
Request.Handler.AbortException
Nested classes/interfaces inherited from interface SessionConfig
SessionConfig.Mutable
-
Field Summary
Fields inherited from interface Invocable
__nonBlocking, NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetManagedSession
(Request request) boolean
Invoked to handle the passed HTTP request and response.newSessionAPIWrapper
(ManagedSession session) void
setHandler
(Handler handler) void
Set theServer
to associate to thisHandler
.Methods inherited from class AbstractSessionManager
access, addSessionStreamWrapper, calculateInactivityTimeout, commit, complete, doStart, doStop, encodeURI, getContext, getManagedSession, getMaxCookieAge, getMaxInactiveInterval, getRefreshCookieAge, getSameSite, getSessionCache, getSessionComment, getSessionContext, getSessionCookie, getSessionCookie, getSessionCookieAttribute, getSessionCookieAttributes, getSessionDomain, getSessionIdManager, getSessionIdPathParameterName, getSessionIdPathParameterNamePrefix, getSessionPath, getSessionsCreated, getSessionTimeMean, getSessionTimeStdDev, getSessionTimeTotal, invalidate, isCheckingRemoteSessionIdEncoding, isHttpOnly, isIdInUse, isPartitioned, isSecureCookies, isSecureRequestOnly, isUsingCookies, isUsingUriParameters, isUsingURLs, newSession, newSessionInactivityTimer, onSessionCreated, onSessionDestroyed, onSessionIdChanged, recordSessionTime, renewSessionId, resolveRequestedSessionId, scavenge, sessionTimerExpired, setCheckingRemoteSessionIdEncoding, setHttpOnly, setMaxCookieAge, setMaxInactiveInterval, setPartitioned, setRefreshCookieAge, setSameSite, setSecureCookies, setSecureRequestOnly, setSessionCache, setSessionComment, setSessionCookie, setSessionCookieAttribute, setSessionDomain, setSessionIdManager, setSessionIdPathParameterName, setSessionPath, setUsingCookies, setUsingUriParameters, setUsingURLs
Methods inherited from class ContainerLifeCycle
addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, 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 Destroyable
destroy
Methods inherited from interface Dumpable.DumpableContainer
isDumpable
Methods inherited from interface Handler.Container
getContainer, getDescendant, getDescendants, getDescendants
Methods inherited from interface Handler.Singleton
getHandlers, getTail, insertHandler, setHandler
Methods inherited from interface LifeCycle
addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop
Methods inherited from interface Request.Handler
getInvocationType
Methods inherited from interface SessionManager
onSessionActivation, onSessionAttributeUpdate, onSessionPassivation
-
Constructor Details
-
SessionHandler
public SessionHandler()
-
-
Method Details
-
setServer
-
getHandler
- Specified by:
getHandler
in interfaceHandler.Singleton
- Returns:
- the child
Handler
-
setHandler
- Specified by:
setHandler
in interfaceHandler.Singleton
- Parameters:
handler
- TheHandler
to set as a child
-
getServer
- Specified by:
getServer
in interfaceHandler
- Specified by:
getServer
in classAbstractSessionManager
- Returns:
- the
Server
associated with thisHandler
-
handle
Description copied from interface:Request.Handler
Invoked to handle the passed HTTP request and response.
The request is accepted by returning true, then handling must be concluded by completing the passed callback. The handling may be asynchronous, i.e. this method may return true and complete the given callback later, possibly from a different thread. If this method returns false, then the callback must not be invoked and any mutation on the response reversed.
Exceptions thrown by this method may be subsequently handled by an error
Request.Handler
, if present, otherwise a default HTTP 500 error is generated and the callback completed while writing the error response.The simplest implementation is:
public boolean handle(Request request, Response response, Callback callback) { callback.succeeded(); return true; }
A HelloWorld implementation is:
public boolean handle(Request request, Response response, Callback callback) { response.write(true, ByteBuffer.wrap("Hello World\n".getBytes(StandardCharsets.UTF_8)), callback); return true; }
- Specified by:
handle
in interfaceRequest.Handler
- Parameters:
request
- the HTTP request to handleresponse
- the HTTP response to handlecallback
- the callback to complete when the handling is complete- Returns:
- True if and only if the request will be handled, a response generated and the callback eventually called. This may occur within the scope of the call to this method, or asynchronously some time later. If false is returned, then this method must not generate a response, nor complete the callback.
- Throws:
Exception
- if there is a failure during the handling. Catchers cannot assume that the callback will be called and thus should attempt to complete the request as if a false had been returned.- See Also:
-
getManagedSession
- Specified by:
getManagedSession
in interfaceSessionManager
-
newSessionAPIWrapper
- Specified by:
newSessionAPIWrapper
in interfaceSessionManager
-