Package com.inductiveautomation.perspective.gateway.rpc

Class PerspectiveGatewayRpc

java.lang.Object

com.inductiveautomation.perspective.gateway.rpc.PerspectiveGatewayRpc

All Implemented Interfaces:

PerspectiveModuleRpc

public class PerspectiveGatewayRpc
extends Object
implements PerspectiveModuleRpc

Field Summary

Fields inherited from interface com.inductiveautomation.perspective.common.rpc.PerspectiveModuleRpc

SERIALIZER

Constructor Summary

Constructors

Constructor	Description
PerspectiveGatewayRpc()

Method Summary

Modifier and Type	Method	Description
void	designerNamedQueriesModified(Map<String,NamedQuery> 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	designerSaved()	Called to notify that the designer has saved successfully.
void	designerScriptsModified(List<Resource> moduleLibraryScripts, @Nullable Resource 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(Resource 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(String viewPath)	Called to notify the gateway that a page was closed, an the corresponding Page should be shut down.
List<PerspectiveFont>	getAllAvailableFonts()	Get all of the available fonts from the Gateway's Font Manager.
Map<String,List<String>>	getAllAvailableIcons()	Fetch a map of all icon library names and their respective icon names
List<Locale>	getAllAvailableLocales()	Get all of the available locales from the Gateway
List<String>	getAllAvailableSecurityLevels()
List<String>	getAllAvailableThemes()	Get all of the available themes from the Gateway's Theme Manager.
List<Translation>	getAllAvailableTranslations()	Get all available translations from the Gateway
Optional<IdentityProviderMeta>	getIdentityProvider(String id)	Get Identity Provider by ID.

Methods inherited from class java.lang.Object

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

Constructor Details

PerspectiveGatewayRpc

public PerspectiveGatewayRpc()

Method Details

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

designerSaved

public void designerSaved()

Description copied from interface: PerspectiveModuleRpc

Called to notify that the designer has saved successfully.

Specified by:

designerSaved in interface PerspectiveModuleRpc

designerTabClosed

public void designerTabClosed(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

designerSessionPropsChanged

public void designerSessionPropsChanged(Resource resource)

Description copied from interface: PerspectiveModuleRpc

Called to notify that the designer has applied a new session props resource.

Specified by:

designerSessionPropsChanged in interface PerspectiveModuleRpc

designerScriptsModified

public void designerScriptsModified(List<Resource> moduleLibraryScripts,
 @Nullable
 @Nullable Resource 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(Map<String,NamedQuery> 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 List<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

getAllAvailableTranslations

public List<Translation> getAllAvailableTranslations()

Description copied from interface: PerspectiveModuleRpc

Get all available translations from the Gateway

Specified by:

getAllAvailableTranslations in interface PerspectiveModuleRpc

Returns:

A List of all the available translations

getAllAvailableThemes

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

getAllAvailableFonts

public List<PerspectiveFont> getAllAvailableFonts()

Description copied from interface: PerspectiveModuleRpc

Get all of the available fonts from the Gateway's Font Manager.

Specified by:

getAllAvailableFonts in interface PerspectiveModuleRpc

Returns:

A List of all the available fonts

getAllAvailableSecurityLevels

public List<String> getAllAvailableSecurityLevels()

Specified by:

getAllAvailableSecurityLevels in interface PerspectiveModuleRpc

Returns:

a List of all the available gson-serialized security level configs

getIdentityProvider

public Optional<IdentityProviderMeta> getIdentityProvider(String id)

Description copied from interface: PerspectiveModuleRpc

Get Identity Provider by ID.

Specified by:

getIdentityProvider in interface PerspectiveModuleRpc

Returns:

an Optional containing the IdentityProviderMeta for the Identity Provider with the given ID, or empty if no Identity Provider exists with the given ID.