Interface WebappPluginWorkspace

    • Field Detail

      • restApiVersion

        static final java.lang.String restApiVersion
        The web-app REST api version
        See Also:
        Constant Field Values
      • OXYGEN_WEBAPP_DATA_DIR

        static final java.lang.String OXYGEN_WEBAPP_DATA_DIR
        Servlet context attribute used to retrieve the data directory. This directory contains:
        • frameworks
        • plugins
        • configuration files
        See Also:
        Constant Field Values
    • Method Detail

      • addEditingSessionLifecycleListener

        void addEditingSessionLifecycleListener​(WebappEditingSessionLifecycleListener listener)
        Registers a listener for the lifecycle events of the editing sessions.
        Parameters:
        listener - The listener to be added.
      • removeEditingSessionLifecycleListener

        void removeEditingSessionLifecycleListener​(WebappEditingSessionLifecycleListener listener)
        Removes the listener.
        Parameters:
        listener - The listener to be removed.
      • getAllEditingSessionLifecycleListeners

        java.util.List<WebappEditingSessionLifecycleListener> getAllEditingSessionLifecycleListeners()
        Returns:
        Returns all the listeners for lifecycle events of the editing sessions.
      • getServletFilters

        java.util.List<javax.servlet.Filter> getServletFilters()
        Returns:
        The list of Servlet filters registered by plugins.
      • getMonitoringStats

        java.util.Map<java.lang.String,​java.lang.String> getMonitoringStats()
        Returns:
        A map with statistics that can be used for monitoring.
        Since:
        19.1
      • setDITAKeyDefinitionManagerProvider

        void setDITAKeyDefinitionManagerProvider​(KeyDefinitionManagerProvider keyDefinitionManagerProvider)
        Sets an object that provides a DITA keys manager for each opened document.
        Parameters:
        keyDefinitionManagerProvider - The provider of the keys manager for opened documents.
        Since:
        19.1
      • getSessionStore

        SessionStore getSessionStore()
        A store which can remember key, values on a given session. The values expire automatically when the session expires.
        Returns:
        A store which can remember key, values on a given session. The values expire automatically when the session expires.
        Since:
        20.0