Package org.exoplatform.portal.application

Class PortalController

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
org.exoplatform.container.web.AbstractHttpServlet
org.exoplatform.portal.application.PortalController
All Implemented Interfaces:
jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable
public class PortalController extends org.exoplatform.container.web.AbstractHttpServlet
The PortalContainer servlet is the main entry point for the eXo Portal product. Both the init() and service() methods are implemented. The first one is used to configure all the portal resources to prepare the platform to receive requests. The second one is used to handle them. Basically, this class is just dispatcher as the real business logic is implemented inside the WebAppController class.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static org.exoplatform.services.log.Log
    log
     

    Fields inherited from class org.exoplatform.container.web.AbstractHttpServlet

    config, servletContextName

    Fields inherited from class jakarta.servlet.http.HttpServlet

    LEGACY_DO_HEAD

  • Constructor Summary

    Constructors
    Constructor
    Description
    PortalController()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    afterInit(jakarta.servlet.ServletConfig config)
    Register onInit callback to PortalContainerPostCreateTask and register the servlet context with RootContainer.
    protected void
    onService(org.exoplatform.container.ExoContainer container, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)
    This method simply delegates the incoming call to the WebAppController stored in the Portal Container object
    protected boolean
    requirePortalEnvironment()
     

    Methods inherited from class org.exoplatform.container.web.AbstractHttpServlet

    getContainer, getServletContext, init, onPortalEnvironmentError, service

    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

    • log

      protected static org.exoplatform.services.log.Log log

  • Constructor Details

    • PortalController

      public PortalController()

  • Method Details

    • afterInit

      public void afterInit(jakarta.servlet.ServletConfig config) throws jakarta.servlet.ServletException
      Register onInit callback to PortalContainerPostCreateTask and register the servlet context with RootContainer. So that portal.war don't need PortalContainerConfigOwner listener. (extension project will need this listener)
      Overrides:
      afterInit in class org.exoplatform.container.web.AbstractHttpServlet
      Throws:
      jakarta.servlet.ServletException
      See Also:
      • AbstractHttpServlet.afterInit(jakarta.servlet.ServletConfig)

    • onService

      protected void onService(org.exoplatform.container.ExoContainer container, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) throws jakarta.servlet.ServletException, IOException
      This method simply delegates the incoming call to the WebAppController stored in the Portal Container object
      Overrides:
      onService in class org.exoplatform.container.web.AbstractHttpServlet
      Throws:
      jakarta.servlet.ServletException
      IOException

    • requirePortalEnvironment

      protected boolean requirePortalEnvironment()
      Overrides:
      requirePortalEnvironment in class org.exoplatform.container.web.AbstractHttpServlet
      See Also:
      • AbstractHttpServlet.requirePortalEnvironment()