Class PerspectiveModuleRpcImpl
- java.lang.Object
-
- com.inductiveautomation.perspective.gateway.PerspectiveModuleRpcImpl
-
- All Implemented Interfaces:
PerspectiveModuleRpc
public class PerspectiveModuleRpcImpl extends java.lang.Object implements PerspectiveModuleRpc
Gateway RPC implementation for the Perspective Module
-
-
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 namesjava.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 Gatewayjava.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.
-
-
-
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 interfacePerspectiveModuleRpc
-
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 interfacePerspectiveModuleRpc
-
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 interfacePerspectiveModuleRpc
-
designerSessionPropsChanged
public void designerSessionPropsChanged(ProjectResource resource)
Description copied from interface:PerspectiveModuleRpc
Called to notify that the designer has applied a new session props resource.- Specified by:
designerSessionPropsChanged
in interfacePerspectiveModuleRpc
-
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 interfacePerspectiveModuleRpc
- Parameters:
moduleLibraryScripts
- List of all module library scripts in the projectlegacyAppScripts
- 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 interfacePerspectiveModuleRpc
- Parameters:
namedQueryMap
- AMap
of named query paths to the serialized bytes ofNamedQuery
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 interfacePerspectiveModuleRpc
- 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 interfacePerspectiveModuleRpc
- 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 interfacePerspectiveModuleRpc
- Returns:
- A map of all icon library names and their respective
lists
of icon names
-
getAllAvailableFonts
public java.util.List<PerspectiveFont> getAllAvailableFonts()
Description copied from interface:PerspectiveModuleRpc
Get all of the available fonts from the Gateway's Font Manager.- Specified by:
getAllAvailableFonts
in interfacePerspectiveModuleRpc
- Returns:
- A
List
of all the availablefonts
-
getAllAvailableSecurityLevels
public java.util.List<java.lang.String> getAllAvailableSecurityLevels()
- Specified by:
getAllAvailableSecurityLevels
in interfacePerspectiveModuleRpc
- Returns:
- a
List
of all the available gson-serialized security level configs
-
getAllAvailableIdpAdapters
public java.util.Map<java.lang.String,IdpAdapterMeta> getAllAvailableIdpAdapters()
Description copied from interface:PerspectiveModuleRpc
Get all of the available IdP adapters from the Gateway's IdP Adapter Manager.- Specified by:
getAllAvailableIdpAdapters
in interfacePerspectiveModuleRpc
- Returns:
- a
Map
of all the availableIdpAdapterMeta
keyed by their internal IDs
-
-