Class AbstractGatewayModuleHook
- java.lang.Object
-
- com.inductiveautomation.ignition.gateway.model.AbstractGatewayModuleHook
-
- All Implemented Interfaces:
GatewayModuleHook
- Direct Known Subclasses:
GatewayHook
,ReportingGatewayHook
,SfcGatewayHook
,TagHistorianGatewayHook
public abstract class AbstractGatewayModuleHook extends java.lang.Object implements GatewayModuleHook
Base class for all gateway module hook implementations. All methods are given empty implementations. It is expected that subclasses will override any methods that they wish to give real implementations.
Best practice is to subclass this class rather than implement
GatewayModuleHook
directly, so that when new methods get added to the interface, your module automatically inherits an empty implementation of the new method rather than breaking with aNoSuchMethodError
.
-
-
Constructor Summary
Constructors Constructor Description AbstractGatewayModuleHook()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
configureDeserializer(XMLDeserializer deserializer)
Provides the module a chance to configure the deserializer with any custom handlersvoid
configureFunctionFactory(ExpressionFunctionManager factory)
Provides the module with an opportunity to define its own expression functionsvoid
configureSerializer(XMLSerializer serializer)
Provides the module a chance to add serialization delegates to the serializer custom for classes that might be encountered when serializing objects provided by this modulejava.util.List<? extends IHomepagePanelDescriptor>
getHomepagePanels()
A list (may be null or empty) of homepage panels that this module providesjava.lang.Object
getRPCHandler(ClientReqSession session, java.lang.String projectName)
A class whose functions will become exposed automatically through reflection to the Designer and the Client through RPCjava.util.List<? extends INamedTab>
getStatusPanels()
A list (may be null or empty) of panels to display in the status sectionvoid
initializeScriptManager(ScriptManager manager)
Initialize a newly-instantiated script manager.void
notifyLicenseStateChanged(LicenseState licenseState)
Notify module hook when the license state has changed.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inductiveautomation.ignition.gateway.model.GatewayModuleHook
getConfigCategories, getConfigOverviewContributor, getConfigPanels, getMountedResourceFolder, getMountPathAlias, getStatusOverviewContributor, initializeResourceTypeAdapterRegistry, isFreeModule, isMakerEditionCompatible, mountRouteHandlers, onMountedResourceRequest, setup, shutdown, startup, updateSystemMap
-
-
-
-
Method Detail
-
getRPCHandler
public java.lang.Object getRPCHandler(ClientReqSession session, java.lang.String projectName)
Description copied from interface:GatewayModuleHook
A class whose functions will become exposed automatically through reflection to the Designer and the Client through RPC- Specified by:
getRPCHandler
in interfaceGatewayModuleHook
-
getHomepagePanels
public java.util.List<? extends IHomepagePanelDescriptor> getHomepagePanels()
Description copied from interface:GatewayModuleHook
A list (may be null or empty) of homepage panels that this module provides- Specified by:
getHomepagePanels
in interfaceGatewayModuleHook
-
getStatusPanels
public java.util.List<? extends INamedTab> getStatusPanels()
Description copied from interface:GatewayModuleHook
A list (may be null or empty) of panels to display in the status section- Specified by:
getStatusPanels
in interfaceGatewayModuleHook
-
configureDeserializer
public void configureDeserializer(XMLDeserializer deserializer)
Description copied from interface:GatewayModuleHook
Provides the module a chance to configure the deserializer with any custom handlers- Specified by:
configureDeserializer
in interfaceGatewayModuleHook
-
configureSerializer
public void configureSerializer(XMLSerializer serializer)
Description copied from interface:GatewayModuleHook
Provides the module a chance to add serialization delegates to the serializer custom for classes that might be encountered when serializing objects provided by this module- Specified by:
configureSerializer
in interfaceGatewayModuleHook
-
configureFunctionFactory
public void configureFunctionFactory(ExpressionFunctionManager factory)
Description copied from interface:GatewayModuleHook
Provides the module with an opportunity to define its own expression functions- Specified by:
configureFunctionFactory
in interfaceGatewayModuleHook
-
notifyLicenseStateChanged
public void notifyLicenseStateChanged(LicenseState licenseState)
Description copied from interface:GatewayModuleHook
Notify module hook when the license state has changed. This could only contain changes for the module or it could contain a change to the platform license (version, restrictions such as expiration date, sqltag count...)- Specified by:
notifyLicenseStateChanged
in interfaceGatewayModuleHook
-
initializeScriptManager
public void initializeScriptManager(ScriptManager manager)
Description copied from interface:GatewayModuleHook
Initialize a newly-instantiated script manager. This will be called exactly once for any givenScriptManager
instance. Usually this will involve callingScriptManager.addScriptModule(String, Object)
, which reflectively loads the public (instance and static) java functions from the given object into the scripting environment, at the provided path.This function may be called before
GatewayModuleHook.startup(LicenseState)
, but never beforeGatewayModuleHook.setup(GatewayContext)
.- Specified by:
initializeScriptManager
in interfaceGatewayModuleHook
-
-