Package org.exoplatform.container.web

Class AbstractHttpServlet

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
org.exoplatform.container.web.AbstractHttpServlet
All Implemented Interfaces:
jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable
public abstract class AbstractHttpServlet extends jakarta.servlet.http.HttpServlet
Created by The eXo Platform SAS Author : Nicolas Filotto nicolas.filotto@exoplatform.com 29 sept. 2009
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected jakarta.servlet.ServletConfig
    config
    The filter configuration
    protected String
    servletContextName
    The Servlet context name

    Fields inherited from class jakarta.servlet.http.HttpServlet

    LEGACY_DO_HEAD

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractHttpServlet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    afterInit(jakarta.servlet.ServletConfig config)
    Allows sub-classes to initialize
    protected final ExoContainer
    getContainer()
     
    jakarta.servlet.ServletContext
    getServletContext()
     
    final void
    init(jakarta.servlet.ServletConfig config)
    protected void
    onPortalEnvironmentError(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
    Allow the sub classed to execute a task when the portal environment could not be set because no related portal container could be found
    protected void
    onService(ExoContainer container, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
    Allow the sub classes to execute a task when the method service is called
    protected boolean
    requirePortalEnvironment()
    Indicates if it requires that a full portal environment must be set
    final void
    service(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
     

    Methods inherited from class jakarta.servlet.http.HttpServlet

    doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

    Methods inherited from class jakarta.servlet.GenericServlet

    destroy, getInitParameter, getInitParameterNames, getServletConfig, 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

    • config

      protected jakarta.servlet.ServletConfig config
      The filter configuration

    • servletContextName

      protected String servletContextName
      The Servlet context name

  • Constructor Details

    • AbstractHttpServlet

      public AbstractHttpServlet()

  • Method Details

    • init

      public final void init(jakarta.servlet.ServletConfig config) throws jakarta.servlet.ServletException
      Specified by:
      init in interface jakarta.servlet.Servlet
      Overrides:
      init in class jakarta.servlet.http.HttpServlet
      Throws:
      jakarta.servlet.ServletException

    • afterInit

      protected void afterInit(jakarta.servlet.ServletConfig config) throws jakarta.servlet.ServletException
      Allows sub-classes to initialize
      Parameters:
      config - the current servlet configuration
      Throws:
      jakarta.servlet.ServletException

    • service

      public final void service(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws jakarta.servlet.ServletException, IOException
      Overrides:
      service in class jakarta.servlet.http.HttpServlet
      Throws:
      jakarta.servlet.ServletException
      IOException
      See Also:
      • HttpServlet.service(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)

    • requirePortalEnvironment

      protected boolean requirePortalEnvironment()
      Indicates if it requires that a full portal environment must be set
      Returns:
      true if it requires the portal environment false otherwise.

    • onService

      protected void onService(ExoContainer container, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws jakarta.servlet.ServletException, IOException
      Allow the sub classes to execute a task when the method service is called
      Parameters:
      container - the eXo container
      req - the HttpServletRequest
      res - the HttpServletResponse
      Throws:
      jakarta.servlet.ServletException
      IOException

    • onPortalEnvironmentError

      protected void onPortalEnvironmentError(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws jakarta.servlet.ServletException, IOException
      Allow the sub classed to execute a task when the portal environment could not be set because no related portal container could be found
      Parameters:
      req - the HttpServletRequest
      res - the HttpServletResponse
      Throws:
      jakarta.servlet.ServletException
      IOException

    • getContainer

      protected final ExoContainer getContainer()
      Returns:
      Gives the ExoContainer that fits best with the current context

    • getServletContext

      public jakarta.servlet.ServletContext getServletContext()
      Specified by:
      getServletContext in interface jakarta.servlet.ServletConfig
      Overrides:
      getServletContext in class jakarta.servlet.GenericServlet
      Returns:
      the current ServletContext