Package com.inductiveautomation.historian.gateway.api

Class HistorianExtensionPoint<S extends HistorianSettings>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint<S>

com.inductiveautomation.historian.gateway.api.HistorianExtensionPoint<S>

Type Parameters:

S - The type of historian settings associated with this extension point.

All Implemented Interfaces:

ExtensionPoint<S>, Comparable<ExtensionPoint<S>>

public abstract class HistorianExtensionPoint<S extends HistorianSettings>
extends AbstractExtensionPoint<S>

Represents an extension point for historian functionality within the gateway.

This abstract class provides the base implementation for historian extension points, allowing custom historian providers to be created and managed. It extends the AbstractExtensionPoint class and defines methods and properties specific to historian-related configurations.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

ExtensionPoint.ComponentType

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceType	RESOURCE_TYPE

Fields inherited from class com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint

descriptionKey, gson, nameKey, typeId, validator

Fields inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

PROFILE_KEY, SETTINGS_KEY

Constructor Summary

Constructors

Constructor	Description
HistorianExtensionPoint(String typeId, String nameKey, String descriptionKey)	Constructs a new HistorianExtensionPoint with the specified identifiers.

Method Summary

Modifier and Type	Method	Description
abstract Historian<S>	createHistorianProvider(GatewayContext context, DecodedResource<ExtensionPointConfig<HistorianProvider,HistorianSettings>> resource)	Creates a historian provider using the specified gateway context and resource configuration.
static ResourceType	getResourceType()
final ResourceType	resourceType()	The resource type shared by all types of this extension point.

Methods inherited from class com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint

addReferenceProperty, addReferenceProperty, buildGson, buildValidator, customizeGson, decode, description, encode, getReferenceProperties, getSettingsValidator, name, typeId, validate

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.config.ExtensionPoint

canCreate, compareTo, defaultProfile, defaultSettings, getMenuActions, getSettings, getSettingsUpgrader, getWebUiComponent, settingsSchema, settingsType

Field Details

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

Constructor Details

HistorianExtensionPoint

public HistorianExtensionPoint(String typeId,
 String nameKey,
 String descriptionKey)

Constructs a new HistorianExtensionPoint with the specified identifiers.

Parameters:

typeId - The unique identifier for the extension point type.

nameKey - The key for the name of the extension point.

descriptionKey - The key for the description of the extension point.

Method Details

getResourceType

public static ResourceType getResourceType()

resourceType

public final ResourceType resourceType()

Description copied from interface: ExtensionPoint

The resource type shared by all types of this extension point. This is used to group extension points together. For example, all alarm journal types would share the same resource type, but have different typeIds.

createHistorianProvider

public abstract Historian<S> createHistorianProvider(GatewayContext context,
 DecodedResource<ExtensionPointConfig<HistorianProvider,HistorianSettings>> resource)
                                              throws Exception

Creates a historian provider using the specified gateway context and resource configuration.

This abstract method must be implemented by subclasses to define how historian providers are created based on the provided context and resource configuration.

Parameters:

context - The gateway context used for creating the historian provider.

resource - The decoded resource containing the extension point configuration.

Returns:

A Historian instance configured with the specified settings.

Throws:

Exception - If an error occurs during the creation of the historian provider.