Package org.atmosphere.cpr

Class AtmosphereServlet

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
org.atmosphere.cpr.AtmosphereServlet
All Implemented Interfaces:
jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable
Direct Known Subclasses:
MeteorServlet
public class AtmosphereServlet extends jakarta.servlet.http.HttpServlet
AtmosphereServlet that use Servlet 3.0 Async API when available, and fallback to native comet support if not available. For Tomcat6/7 and JBossWeb Native support, use atmosphere-native dependencies instead.

If Servlet 3.0 or native API isn't found, Atmosphere will use BlockingIOCometSupport.

Author:
Jeanfrancois Arcand
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final AtmosphereFrameworkInitializer
    initializer
     
    protected static final org.slf4j.Logger
    logger
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AtmosphereServlet()
    Create an Atmosphere Servlet.
    AtmosphereServlet(boolean isFilter)
    Create an Atmosphere Servlet.
    AtmosphereServlet(boolean isFilter, boolean autoDetectHandlers)
    Create an Atmosphere Servlet.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected AtmosphereServlet
    configureFramework(jakarta.servlet.ServletConfig sc)
     
    protected AtmosphereServlet
    configureFramework(jakarta.servlet.ServletConfig sc, boolean init)
     
    void
    destroy()
     
    void
    doDelete(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
    Delegate the request processing to an instance of AsyncSupport.
    void
    doGet(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
    Delegate the request processing to an instance of AsyncSupport.
    void
    doHead(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
    Delegate the request processing to an instance of AsyncSupport.
    void
    doOptions(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
    Delegate the request processing to an instance of AsyncSupport
    void
    doPost(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
    Delegate the request processing to an instance of AsyncSupport.
    void
    doPut(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
    Delegate the request processing to an instance of AsyncSupport.
    void
    doTrace(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
    Delegate the request processing to an instance of AsyncSupport.
    AtmosphereFramework
    framework()
     
    void
    init(jakarta.servlet.ServletConfig sc)
     
    protected AtmosphereFramework
    newAtmosphereFramework()
     

    Methods inherited from class jakarta.servlet.http.HttpServlet

    getLastModified, service, service

    Methods inherited from class jakarta.servlet.GenericServlet

    getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • AtmosphereServlet

      public AtmosphereServlet()
      Create an Atmosphere Servlet.

    • AtmosphereServlet

      public AtmosphereServlet(boolean isFilter)
      Create an Atmosphere Servlet.
      Parameters:
      isFilter - true if this instance is used as an AtmosphereFilter

    • AtmosphereServlet

      public AtmosphereServlet(boolean isFilter, boolean autoDetectHandlers)
      Create an Atmosphere Servlet.
      Parameters:
      isFilter - true if this instance is used as an AtmosphereFilter

  • Method Details

    • destroy

      public void destroy()
      Specified by:
      destroy in interface jakarta.servlet.Servlet
      Overrides:
      destroy in class jakarta.servlet.GenericServlet

    • init

      public void init(jakarta.servlet.ServletConfig sc) throws jakarta.servlet.ServletException
      Specified by:
      init in interface jakarta.servlet.Servlet
      Overrides:
      init in class jakarta.servlet.GenericServlet
      Throws:
      jakarta.servlet.ServletException

    • configureFramework

      protected AtmosphereServlet configureFramework(jakarta.servlet.ServletConfig sc) throws jakarta.servlet.ServletException
      Throws:
      jakarta.servlet.ServletException

    • configureFramework

      protected AtmosphereServlet configureFramework(jakarta.servlet.ServletConfig sc, boolean init) throws jakarta.servlet.ServletException
      Throws:
      jakarta.servlet.ServletException

    • newAtmosphereFramework

      protected AtmosphereFramework newAtmosphereFramework()

    • framework

      public AtmosphereFramework framework()

    • doHead

      public void doHead(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, jakarta.servlet.ServletException
      Delegate the request processing to an instance of AsyncSupport.
      Overrides:
      doHead in class jakarta.servlet.http.HttpServlet
      Parameters:
      req - the HttpServletRequest
      res - the HttpServletResponse
      Throws:
      IOException
      jakarta.servlet.ServletException

    • doOptions

      public void doOptions(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, jakarta.servlet.ServletException
      Delegate the request processing to an instance of AsyncSupport
      Overrides:
      doOptions in class jakarta.servlet.http.HttpServlet
      Parameters:
      req - the HttpServletRequest
      res - the HttpServletResponse
      Throws:
      IOException
      jakarta.servlet.ServletException

    • doTrace

      public void doTrace(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, jakarta.servlet.ServletException
      Delegate the request processing to an instance of AsyncSupport.
      Overrides:
      doTrace in class jakarta.servlet.http.HttpServlet
      Parameters:
      req - the HttpServletRequest
      res - the HttpServletResponse
      Throws:
      IOException
      jakarta.servlet.ServletException

    • doDelete

      public void doDelete(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, jakarta.servlet.ServletException
      Delegate the request processing to an instance of AsyncSupport.
      Overrides:
      doDelete in class jakarta.servlet.http.HttpServlet
      Parameters:
      req - the HttpServletRequest
      res - the HttpServletResponse
      Throws:
      IOException
      jakarta.servlet.ServletException

    • doPut

      public void doPut(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, jakarta.servlet.ServletException
      Delegate the request processing to an instance of AsyncSupport.
      Overrides:
      doPut in class jakarta.servlet.http.HttpServlet
      Parameters:
      req - the HttpServletRequest
      res - the HttpServletResponse
      Throws:
      IOException
      jakarta.servlet.ServletException

    • doGet

      public void doGet(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, jakarta.servlet.ServletException
      Delegate the request processing to an instance of AsyncSupport.
      Overrides:
      doGet in class jakarta.servlet.http.HttpServlet
      Parameters:
      req - the HttpServletRequest
      res - the HttpServletResponse
      Throws:
      IOException
      jakarta.servlet.ServletException

    • doPost

      public void doPost(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws IOException, jakarta.servlet.ServletException
      Delegate the request processing to an instance of AsyncSupport.
      Overrides:
      doPost in class jakarta.servlet.http.HttpServlet
      Parameters:
      req - the HttpServletRequest
      res - the HttpServletResponse
      Throws:
      IOException
      jakarta.servlet.ServletException