Package ro.sync.ecss.extensions.api.webapp.access

Interface WebappPluginWorkspace

All Superinterfaces:
ApplicationInformationAccess, ColorThemeUtilities, DiffAndMergeTools, GlobalOptionsStorage, MathFlowConfigurator, PluginWorkspace, ReferencesCustomizer, StandalonePluginWorkspace, Workspace, WorkspaceUtilities
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface WebappPluginWorkspace extends StandalonePluginWorkspace
Plugin workspace access API with webapp-specific features. To obtain an instance of this class, one can either register a WorkspaceAccessPluginExtension or use PluginWorkspaceProvider.
Since:
17

  • Field Details

    • restApiVersion

      static final String restApiVersion
      The web-app REST api version
      See Also:

    • OXYGEN_WEBAPP_DATA_DIR

      static final String OXYGEN_WEBAPP_DATA_DIR
      Servlet context attribute used to retrieve the data directory. This directory contains:
      • frameworks
      • plugins
      • configuration files
      See Also:

  • Method Details

    • addEditingSessionLifecycleListener

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

    • addDITAMapEditingSessionLifecycleListener

      void addDITAMapEditingSessionLifecycleListener(WebappEditingSessionLifecycleListener listener)
      Registers a listener for the lifecycle events of the editing sessions for an editable DITA Map opened in the DITA Maps Manager component.
      Parameters:
      listener - The listener to be added.
      Since:
      26.1

    • removeEditingSessionLifecycleListener

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

    • removeDITAMapEditingSessionLifecycleListener

      void removeDITAMapEditingSessionLifecycleListener(WebappEditingSessionLifecycleListener listener)
      Removes the listener for an editable DITA Map's editing session for an editable DITA Map opened in the DITA Maps Manager component.
      Parameters:
      listener - The listener to be removed.
      Since:
      26.1

    • getAllEditingSessionLifecycleListeners

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

    • getAllDITAMapEditingSessionLifecycleListeners

      List<WebappEditingSessionLifecycleListener> getAllDITAMapEditingSessionLifecycleListeners()
      Returns:
      Returns all the listeners for lifecycle events of editable DITA Maps opened in the DITA Maps Manager component.
      Since:
      26.1

    • getServletFilters

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

    • getMonitoringStats

      Map<String,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