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 historian settings type
- All Implemented Interfaces:
ExtensionPoint<S>, Comparable<ExtensionPoint<S>>
public abstract class HistorianExtensionPoint<S extends HistorianSettings>
extends AbstractExtensionPoint<S>
Extension point through which a module supplies a historian provider: it names the type and
creates the
Historian from its resource configuration.-
Nested Class Summary
Nested classes/interfaces inherited from interface ExtensionPoint
ExtensionPoint.ComponentType -
Field Summary
FieldsFields inherited from class AbstractExtensionPoint
descriptionKey, gson, nameKey, typeId, validatorFields inherited from interface ExtensionPoint
PROFILE_KEY, SETTINGS_KEY -
Constructor Summary
ConstructorsConstructorDescriptionHistorianExtensionPoint(String typeId, String nameKey, String descriptionKey) -
Method Summary
Modifier and TypeMethodDescriptioncreateHistorianProvider(GatewayContext context, DecodedResource<ExtensionPointConfig<HistorianProvider, HistorianSettings>> resource) Creates a historian provider from its resource configuration.static ResourceTypefinal ResourceTypeThe resource type shared by all types of this extension point.Methods inherited from class AbstractExtensionPoint
addReferenceProperty, addReferenceProperty, buildGson, buildValidator, customizeGson, decode, description, encode, getReferenceProperties, getSettingsValidator, name, typeId, validateMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface ExtensionPoint
allowDisableOnRestore, canCreate, compareTo, defaultProfile, defaultSettings, getCreateSteps, getDiagnostics, getMenuActions, getSettings, getSettingsUpgrader, getWebUiComponent, settingsSchema, settingsType
-
Field Details
-
RESOURCE_TYPE
-
-
Constructor Details
-
HistorianExtensionPoint
-
-
Method Details
-
getResourceType
-
resourceType
Description copied from interface:ExtensionPointThe 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 from its resource configuration.- Parameters:
context- the gateway contextresource- the decoded resource holding the configuration- Returns:
- the historian
- Throws:
Exception- if the provider cannot be created
-