Package com.inductiveautomation.perspective.gateway

Class PerspectiveModuleRpcImpl

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void designerNamedQueriesModified​(java.util.Map<java.lang.String,​byte[]> namedQueryMap)
      Updates the PerspectiveDesignSession on the Gateway with the named query changes local to this Designer instance so that executions of named queries on the Gateway reflect the latest changes in this Designer instance.
      void designerScriptsModified​(java.util.List<ProjectResource> moduleLibraryScripts, ProjectResource legacyAppScripts)
      Updates the necessary Script Managers on the Gateway when the Designer scripts change so that the designer session's models running on the gateway act against the latest unsaved Designer changes.
      void designerSessionPropsChanged​(ProjectResource resource)
      Called to notify that the designer has applied a new session props resource.
      void designerShutdown()
      Called to notify that the designer has closed.
      void designerStartup()
      Called to notify that a designer has started.
      void designerTabClosed​(java.lang.String viewPath)
      Called to notify the gateway that a page was closed, an the corresponding Page should be shut down.
      java.util.List<PerspectiveFont> getAllAvailableFonts()
      Get all of the available fonts from the Gateway's Font Manager.
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getAllAvailableIcons()
      Fetch a map of all icon library names and their respective icon names
      java.util.Map<java.lang.String,​IdpAdapterMeta> getAllAvailableIdpAdapters()
      Get all of the available IdP adapters from the Gateway's IdP Adapter Manager.
      java.util.List<java.util.Locale> getAllAvailableLocales()
      Get all of the available locales from the Gateway
      java.util.List<java.lang.String> getAllAvailableSecurityLevels()  
      java.util.List<java.lang.String> getAllAvailableThemes()
      Get all of the available themes from the Gateway's Theme Manager.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • designerStartup

        public void designerStartup()
        Description copied from interface: PerspectiveModuleRpc
        Called to notify that a designer has started. Even though no views are running, the session props will start.
        Specified by:
        designerStartup in interface PerspectiveModuleRpc

      • designerShutdown

        public void designerShutdown()
        Description copied from interface: PerspectiveModuleRpc
        Called to notify that the designer has closed. Used for more timely shutdown of the session-side models, in cases where the designer closes cleanly.
        Specified by:
        designerShutdown in interface PerspectiveModuleRpc

      • designerTabClosed

        public void designerTabClosed​(java.lang.String viewPath)
        Description copied from interface: PerspectiveModuleRpc
        Called to notify the gateway that a page was closed, an the corresponding Page should be shut down.
        Specified by:
        designerTabClosed in interface PerspectiveModuleRpc

      • designerScriptsModified

        public void designerScriptsModified​(java.util.List<ProjectResource> moduleLibraryScripts,
                                    ProjectResource legacyAppScripts)
        Description copied from interface: PerspectiveModuleRpc
        Updates the necessary Script Managers on the Gateway when the Designer scripts change so that the designer session's models running on the gateway act against the latest unsaved Designer changes.
        Specified by:
        designerScriptsModified in interface PerspectiveModuleRpc
        Parameters:
        moduleLibraryScripts - List of all module library scripts in the project
        legacyAppScripts - The resource that holds the legacy app.* scripts, if any, or else null.

      • designerNamedQueriesModified

        public void designerNamedQueriesModified​(java.util.Map<java.lang.String,​byte[]> namedQueryMap)
        Description copied from interface: PerspectiveModuleRpc
        Updates the PerspectiveDesignSession on the Gateway with the named query changes local to this Designer instance so that executions of named queries on the Gateway reflect the latest changes in this Designer instance.
        Specified by:
        designerNamedQueriesModified in interface PerspectiveModuleRpc
        Parameters:
        namedQueryMap - A Map of named query paths to the serialized bytes of NamedQuery instances for those named queries which have changed in this Designer instance. Null NamedQuery values mean that the NamedQuery with the given path has been deleted locally.

      • getAllAvailableLocales

        public java.util.List<java.util.Locale> getAllAvailableLocales()
        Description copied from interface: PerspectiveModuleRpc
        Get all of the available locales from the Gateway
        Specified by:
        getAllAvailableLocales in interface PerspectiveModuleRpc
        Returns:
        A List of all the available locales

      • getAllAvailableThemes

        public java.util.List<java.lang.String> getAllAvailableThemes()
        Description copied from interface: PerspectiveModuleRpc
        Get all of the available themes from the Gateway's Theme Manager.
        Specified by:
        getAllAvailableThemes in interface PerspectiveModuleRpc
        Returns:
        A List of all the available themes

      • getAllAvailableIcons

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getAllAvailableIcons()
        Description copied from interface: PerspectiveModuleRpc
        Fetch a map of all icon library names and their respective icon names
        Specified by:
        getAllAvailableIcons in interface PerspectiveModuleRpc
        Returns:
        A map of all icon library names and their respective lists of icon names

      • getAllAvailableSecurityLevels

        public java.util.List<java.lang.String> getAllAvailableSecurityLevels()
        Specified by:
        getAllAvailableSecurityLevels in interface PerspectiveModuleRpc
        Returns:
        a List of all the available gson-serialized security level configs