Package com.inductiveautomation.ignition.gateway.model

Class AbstractGatewayModuleHook

java.lang.Object

com.inductiveautomation.ignition.gateway.model.AbstractGatewayModuleHook

All Implemented Interfaces:

GatewayModuleHook

Direct Known Subclasses:

EventStreamGatewayHook, GatewayHook, HistorianGatewayHook, ReportingGatewayHook, SfcGatewayHook

public abstract class AbstractGatewayModuleHook
extends 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 a NoSuchMethodError.

Constructor Summary

Constructors

Constructor	Description
AbstractGatewayModuleHook()

Method Summary

Modifier and Type	Method	Description
void	configureDeserializer(XMLDeserializer deserializer)	Provides the module a chance to configure the deserializer with any custom handlers
void	configureFunctionFactory(ExpressionFunctionManager factory)	Provides the module with an opportunity to define its own expression functions
void	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 module
Optional<GatewayRpcImplementation>	getRpcImplementation()	Returns the RPC implementation for this module, if any.
void	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

getExtensionPoints, getMountedResourceFolder, getMountPathAlias, getRecordMigrationStrategies, isFreeModule, isMakerEditionCompatible, mountRouteHandlers, onMountedResourceRequest, setup, shutdown, startup

Constructor Details

AbstractGatewayModuleHook

public AbstractGatewayModuleHook()

Method Details

getRpcImplementation

public Optional<GatewayRpcImplementation> getRpcImplementation()

Description copied from interface: GatewayModuleHook

Returns the RPC implementation for this module, if any. This is the recommended way to expose RPC functions to the Designer or Vision Client if required. The return value will be cached for the lifetime of the Gateway.

Specified by:

getRpcImplementation in interface GatewayModuleHook

See Also:

• RpcInterface

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 interface GatewayModuleHook

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 interface GatewayModuleHook

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 interface GatewayModuleHook

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 interface GatewayModuleHook

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 given ScriptManager instance. Usually this will involve calling ScriptManager.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 before GatewayModuleHook.setup(GatewayContext).

Specified by:

initializeScriptManager in interface GatewayModuleHook