Interface IWebMemoryArea


  • public interface IWebMemoryArea
    Interface used by the server-side bridge and by server-side web processors to access server-side web memory slots.
    Author:
    Sergejs Kozlovics
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getProjectFolder​(java.lang.String project_id)
      Returns the cache folder for the given webAppOS project.
      java.lang.String getProjectFullAppName​(java.lang.String project_id)
      Returns the full webAppOS app name used to open the given project.
      IWebMemory getWebMemory​(java.lang.String project_id)
      Returns an object (it can be a wrapper) that can be used to access web memory of the given project.
      boolean renameActiveProject​(java.lang.String project_id, java.lang.String new_project_id)
      Renames an active project (and re-assocates the project cache folder with the new project file).
      void webMemoryFault​(java.lang.String project_id)
      Clears the web memory slot for the given project and disconnects all users by calling onFault runnables (within slot.done()).
    • Method Detail

      • getWebMemory

        IWebMemory getWebMemory​(java.lang.String project_id)
        Returns an object (it can be a wrapper) that can be used to access web memory of the given project.
        Parameters:
        project_id - the project_id for which web memory to get access
        Returns:
        a pointer to web memory or null if the project is not active/not found
      • getProjectFolder

        java.lang.String getProjectFolder​(java.lang.String project_id)
        Returns the cache folder for the given webAppOS project.
        Parameters:
        project_id - the project_id for which to get the cache folder
        Returns:
        project cache folder, or null if the project is not active/not found
      • getProjectFullAppName

        java.lang.String getProjectFullAppName​(java.lang.String project_id)
        Returns the full webAppOS app name used to open the given project.
        Parameters:
        project_id - the project_id for which to get the app using the project
        Returns:
        full app name or null, if the project is not active/not found
      • renameActiveProject

        boolean renameActiveProject​(java.lang.String project_id,
                                    java.lang.String new_project_id)
        Renames an active project (and re-assocates the project cache folder with the new project file).
        Parameters:
        project_id - active project id
        new_project_id - desired project id
        Returns:
        whether the operation succeeded
      • webMemoryFault

        void webMemoryFault​(java.lang.String project_id)
        Clears the web memory slot for the given project and disconnects all users by calling onFault runnables (within slot.done()).
        Parameters:
        project_id - the project_id for which to perform "web memory fault" action.