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.ee10.servlet.SessionHandler
All Implemented Interfaces:
Handler, Handler.Container, Handler.Singleton, Request.Handler, SessionConfig, SessionConfig.Mutable, SessionManager, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, Invocable
public class SessionHandler extends AbstractSessionManager implements Handler.Singleton

  • Field Details

    • DEFAULT_SESSION_TRACKING_MODES

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

  • Constructor Details

    • SessionHandler

      public SessionHandler()

  • Method Details

    • setServer

      public void setServer(Server server)
      Description copied from interface: Handler
      Set the Server to associate to this Handler.
      Specified by:
      setServer in interface Handler
      Parameters:
      server - the Server to associate to this Handler

    • getInvocationType

      public Invocable.InvocationType getInvocationType()
      Specified by:
      getInvocationType in interface Handler.Singleton
      Specified by:
      getInvocationType in interface Invocable
      Specified by:
      getInvocationType in interface Request.Handler
      Returns:
      The InvocationType of this object

    • getHandler

      public Handler getHandler()
      Specified by:
      getHandler in interface Handler.Singleton
      Returns:
      the child Handler

    • setHandler

      public void setHandler(Handler handler)
      Specified by:
      setHandler in interface Handler.Singleton
      Parameters:
      handler - The Handler to set as a child

    • getServer

      public Server getServer()
      Specified by:
      getServer in interface Handler
      Specified by:
      getServer in class AbstractSessionManager
      Returns:
      the Server associated with this Handler

    • getManagedSession

      public ManagedSession getManagedSession(Request request)
      Specified by:
      getManagedSession in interface SessionManager

    • 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

      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:

    • doStart

      public void doStart() throws Exception
      Description copied from class: ContainerLifeCycle
      Starts the managed lifecycle beans in the order they were added.
      Overrides:
      doStart in class AbstractSessionManager
      Throws:
      Exception - If there was a problem starting. Will cause a transition to FAILED state

    • configureCookies

      protected void configureCookies()
      Set up cookie configuration based on init params

    • newSessionAPIWrapper

      public Session.API newSessionAPIWrapper(ManagedSession session)
      Specified by:
      newSessionAPIWrapper in interface SessionManager

    • onSessionAttributeUpdate

      public void onSessionAttributeUpdate(Session session, String name, Object old, Object value)
      Specified by:
      onSessionAttributeUpdate in interface SessionManager

    • onSessionCreated

      public void onSessionCreated(Session session)
      Call the session lifecycle listeners in the order they were added.
      Specified by:
      onSessionCreated in interface SessionManager
      Overrides:
      onSessionCreated in class AbstractSessionManager
      Parameters:
      session - the session on which to call the lifecycle listeners

    • onSessionDestroyed

      public void onSessionDestroyed(Session session)
      Call the session lifecycle listeners in the reverse order they were added.
      Specified by:
      onSessionDestroyed in interface SessionManager
      Overrides:
      onSessionDestroyed in class AbstractSessionManager
      Parameters:
      session - the session on which to call the lifecycle listeners

    • onSessionIdChanged

      public void onSessionIdChanged(Session session, String oldId)
      Specified by:
      onSessionIdChanged in interface SessionManager
      Overrides:
      onSessionIdChanged in class AbstractSessionManager

    • callUnboundBindingListener

      protected void callUnboundBindingListener(Session session, String name, Object value)

    • callBoundBindingListener

      protected void callBoundBindingListener(Session session, String name, Object value)

    • onSessionActivation

      public void onSessionActivation(Session session)
      Specified by:
      onSessionActivation in interface SessionManager

    • onSessionPassivation

      public void onSessionPassivation(Session session)
      Specified by:
      onSessionPassivation in interface SessionManager

    • getSessionCookieConfig

      public jakarta.servlet.SessionCookieConfig getSessionCookieConfig()

    • getDefaultSessionTrackingModes

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

    • getEffectiveSessionTrackingModes

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

    • getSameSite

      public HttpCookie.SameSite getSameSite()
      Specified by:
      getSameSite in interface SessionConfig
      Overrides:
      getSameSite in class AbstractSessionManager

    • setSameSite

      public void setSameSite(HttpCookie.SameSite sameSite)
      Set Session cookie sameSite mode. In ee10 this is set as a generic session cookie attribute.
      Specified by:
      setSameSite in interface SessionConfig.Mutable
      Overrides:
      setSameSite in class AbstractSessionManager
      Parameters:
      sameSite - The sameSite setting for Session cookies (or null for no sameSite setting)

    • setSessionTrackingModes

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

    • handle

      public boolean handle(Request request, Response response, Callback callback) throws Exception
      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 interface Request.Handler
      Parameters:
      request - the HTTP request to handle
      response - the HTTP response to handle
      callback - 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: