com.inductiveautomation.xopc.driver.common

Class AbstractDriverModuleHook

java.lang.Object

com.inductiveautomation.ignition.gateway.model.AbstractGatewayModuleHook

com.inductiveautomation.xopc.driver.common.AbstractDriverModuleHook

All Implemented Interfaces:

GatewayModuleHook, ModuleServiceConsumer

public abstract class AbstractDriverModuleHook
extends AbstractGatewayModuleHook
implements ModuleServiceConsumer

A nearly complete implementation of a GatewayModuleHook for driver modules. All that is needed is for the implementation to provide DriverMeta(s). All of the registration tasks are taken care of from there.

Constructor Summary

Constructors

Constructor and Description
AbstractDriverModuleHook()

Method Summary

Modifier and Type	Method and Description
GatewayContext	getContext()
protected java.util.Optional<DriverManager>	getDriverManager() Get the DriverManager, if the ModuleServicesManager has indicated it's available.
protected abstract java.util.List<DriverType>	getDriverTypes()
protected abstract int	getExpectedAPIVersion()
protected void	runLegacyConversions(GatewayContext context) Run any legacy property conversions if necessary.
void	serviceReady(java.lang.Class<?> serviceClass) The service indicated by serviceClass is ready for use.
void	serviceShutdown(java.lang.Class<?> serviceClass) The service indicated by serviceClass has shut down.
void	setup(GatewayContext context) Called to before startup.
void	shutdown() Called to shutdown this module.
void	startup(LicenseState activationState) Called to initialize the module.

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

configureDeserializer, configureFunctionFactory, configureSerializer, getHomepagePanels, getRPCHandler, getStatusPanels, 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

getConfigCategories, getConfigOverviewContributor, getConfigPanels, getMountedResourceFolder, getMountPathAlias, getStatusOverviewContributor, isFreeModule, mountRouteHandlers, updateSystemMap

Constructor Detail

AbstractDriverModuleHook

public AbstractDriverModuleHook()

Method Detail

getDriverTypes

protected abstract java.util.List<DriverType> getDriverTypes()

Returns:

A list of DriverTypes to be registered with the DriverManager.

getExpectedAPIVersion

protected abstract int getExpectedAPIVersion()

Returns:

The expected DriverAPI.VERSION number. Changes in API version are not backwards compatible; if these do not match the module will not start.

setup

public void setup(GatewayContext context)

Description copied from interface: GatewayModuleHook

Called to before startup. This is the chance for the module to add its extension points and update persistent records and schemas. None of the managers will be started up at this point, but the extension point managers will accept extension point types.

Specified by:

setup in interface GatewayModuleHook

startup

public void startup(LicenseState activationState)

Description copied from interface: GatewayModuleHook

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

Specified by:

startup in interface GatewayModuleHook

shutdown

public void shutdown()

Description copied from interface: GatewayModuleHook

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

Specified by:

shutdown in interface GatewayModuleHook

serviceReady

public void serviceReady(java.lang.Class<?> serviceClass)

Description copied from interface: ModuleServiceConsumer

The service indicated by serviceClass is ready for use. It can be retrieved from the ModuleServicesManager by calling getService().

Specified by:

serviceReady in interface ModuleServiceConsumer

serviceShutdown

public void serviceShutdown(java.lang.Class<?> serviceClass)

Description copied from interface: ModuleServiceConsumer

The service indicated by serviceClass has shut down.

Specified by:

serviceShutdown in interface ModuleServiceConsumer

getContext

public GatewayContext getContext()

getDriverManager

protected java.util.Optional<DriverManager> getDriverManager()

Get the DriverManager, if the ModuleServicesManager has indicated it's available.

Generally, the DriverManager should be available after startup(LicenseState) and before shutdown().

Returns:

The DriverManager, if it's available.

runLegacyConversions

protected void runLegacyConversions(GatewayContext context)

Run any legacy property conversions if necessary. See LegacyDeviceConfigConverter.