Package com.microstrategy.web.app.beans

Class ServletWebComponent

    • Constructor Detail

      • ServletWebComponent

        public ServletWebComponent()
        Creates a new ServletWebComponent with default parameters.
        This ServletWebComponent uses "mstrWeb" as its name, ServletEventHandlerImpl (which implements ServletEventHandler) as its event handler and has no parent.

      • ServletWebComponent

        public ServletWebComponent​(java.lang.String name)
        Creates a new ServletWebComponent with default parameters but a custom name.
        This ServletWebComponent uses ServletEventHandlerImpl (which implements ServletEventHandler) as its event handler and has no parent.

    • Method Detail

      • setIsOpen

        public void setIsOpen​(boolean value)
        This is an illegal method: the servlet should never get closed. If the argument received is false, this will throw an IllegalArgumentException
        Specified by:
        setIsOpen in interface AppComponent
        Overrides:
        setIsOpen in class AbstractAppComponent
        Parameters:
        value - boolean
        Since:
        MicroStrategy Web 8.0.0

      • isOpen

        public boolean isOpen()
        Overrides isOpen by always returning true: there is no reason why would the servlet be closed.
        Specified by:
        isOpen in interface AppComponent
        Overrides:
        isOpen in class AbstractAppComponent
        Returns:
        true
        Since:
        MicroStrategy Web 8.0.0

      • getPage

        public PageComponent getPage()
        Gets the PageComponent (already initialized) to be used by this servlet.
        Returns:
        page a PageComponent already initialized to be used

      • getCurrentServer

        public java.lang.String getCurrentServer()
        Returns the server of the current session
        Returns:
        a String value with the current server name

      • getCurrentProject

        public java.lang.String getCurrentProject()
        Returns the project of the current session
        Returns:
        a String value with the current project name

      • getCurrentPort

        public java.lang.String getCurrentPort()
        Returns the port of the current session
        Returns:
        a String value with the current port number

      • getPageHistoryList

        public PageHistoryList getPageHistoryList()
        Returns:
        The Page History List object
        Since:
        MicroStrategy Web 9.0.0

      • getPendingEvents

        public SimpleList getPendingEvents()
        Returns the list of events that were not processed.
        This list is retrieved directly from the EventHandler, since it's its responsibility. For this to happen the event handler needs to extend ServletEventHandler.
        Returns:
        a List with the events that were not processed during handleRequest().

      • isEventWait

        public boolean isEventWait()

      • saveLastSuccesfulPage

        public void saveLastSuccesfulPage​(PageComponent page)
        Deprecated.
        Saves the information of the last succesful page so it can be restored by the cancel event.
        Parameters:
        page - the page to save.

      • saveLastSuccesfulPage

        public void saveLastSuccesfulPage()
        Deprecated.
        Saves the information of the last succesful page so it can be restored by the cancel event.