Package com.inductiveautomation.historian.gateway.api

Class HistorianModule

java.lang.Object

com.inductiveautomation.ignition.gateway.model.AbstractGatewayModuleHook

com.inductiveautomation.historian.gateway.api.HistorianModule

All Implemented Interfaces:

GatewayModuleHook

public abstract class HistorianModule
extends AbstractGatewayModuleHook

A module that extends the AbstractGatewayModuleHook to provide additional functionality specific to the management and operation of the Historian. This abstract class serves as a base for concrete implementations that interact with the HistorianManager and provide data-related services on the gateway.

Constructor Summary

Constructors

Constructor	Description
HistorianModule()

Method Summary

Modifier and Type	Method	Description
static HistorianModule	get(GatewayContext context)	Retrieves the HistorianModule instance associated with the specified GatewayContext.
abstract HistorianManager	getHistorianManager()	Retrieves the HistorianManager instance associated with this module.

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

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

Constructor Details

HistorianModule

public HistorianModule()

Method Details

get

public static HistorianModule get(GatewayContext context)

Retrieves the HistorianModule instance associated with the specified GatewayContext.

Parameters:

context - the GatewayContext from which the HistorianModule is retrieved

Returns:

the HistorianModule instance corresponding to the provided context

getHistorianManager

public abstract HistorianManager getHistorianManager()

Retrieves the HistorianManager instance associated with this module. The HistorianManager provides methods to access and manage historian-related components, including storage and query engines for historians.

Returns:

the HistorianManager instance used for managing historian functionality