Package org.eclipse.jetty.session

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
public class SessionHandler extends AbstractSessionManager implements Handler.Singleton
A simple core SessionHandler

  • 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

    • 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

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

    • getManagedSession

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

    • newSessionAPIWrapper

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