Package com.inductiveautomation.ignition.gateway.opcua.server.api

Class AbstractDeviceModuleHook

java.lang.Object

com.inductiveautomation.ignition.gateway.model.AbstractGatewayModuleHook

com.inductiveautomation.ignition.gateway.opcua.server.api.AbstractDeviceModuleHook

All Implemented Interfaces:

GatewayModuleHook

public abstract class AbstractDeviceModuleHook
extends AbstractGatewayModuleHook

A partial implementation of GatewayModuleHook for modules that provide DeviceExtensionPoints.

Constructor Summary

Constructors

Constructor	Description
AbstractDeviceModuleHook()

Method Summary

Modifier and Type	Method	Description
protected @Nullable GatewayContext	getContext()	Get the GatewayContext.
protected abstract List<DeviceExtensionPoint<?>>	getDeviceExtensionPoints()	Get the DeviceExtensionPoints provided by this module.
final List<ExtensionPoint<?>>	getExtensionPoints()
void	setup(GatewayContext context)	Subclasses that override should call super.setup(context).
void	shutdown()	No-op, subclasses may override.
void	startup(LicenseState activationState)	No-op, subclasses may override.

Methods inherited from class com.inductiveautomation.ignition.gateway.model.AbstractGatewayModuleHook

configureDeserializer, configureFunctionFactory, configureSerializer, getRpcImplementation, initializeScriptManager, notifyLicenseStateChanged

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

getMountedResourceFolder, getMountPathAlias, getRecordMigrationStrategies, isFreeModule, isMakerEditionCompatible, mountRouteHandlers, onMountedResourceRequest

Constructor Details

AbstractDeviceModuleHook

public AbstractDeviceModuleHook()

Method Details

setup

public void setup(GatewayContext context)

Subclasses that override should call super.setup(context).

Called before register. The module can create data structures, loggers, etc. The module should not reach out to other parts of the system and expect them to be ready or created yet.

startup

public void startup(LicenseState activationState)

No-op, subclasses may override.

Called to initialize the module. Will only be called once. Persistence interface is available, but only in read-only mode.

shutdown

public void shutdown()

No-op, subclasses may override.

Called to shutdown this module. Note that this instance will never be started back up - a new one will be created if a restart is desired

getExtensionPoints

public final List<ExtensionPoint<?>> getExtensionPoints()

Returns:

a list of any extension points this module wants to add to any extension point systems. This list will be a mixed-type list. Extension point managers will filter through the list and find the types that they are interested in.

getContext

@Nullable
protected @Nullable GatewayContext getContext()

Get the GatewayContext.

May be null if setup(GatewayContext) has not been called yet.

Returns:

the GatewayContext.

getDeviceExtensionPoints

protected abstract List<DeviceExtensionPoint<?>> getDeviceExtensionPoints()

Get the DeviceExtensionPoints provided by this module.

Returns:

a List of DeviceExtensionPoints provided by this module.