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.
  • Field Details

    • RESOURCE_TYPE

      public static final ResourceType RESOURCE_TYPE
  • Constructor Details

    • HistorianExtensionPoint

      public HistorianExtensionPoint(String typeId, String nameKey, String descriptionKey)
      Parameters:
      typeId - the unique id of the extension point type
      nameKey - the key of the extension point's name
      descriptionKey - the key of the extension point's description
  • 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 from its resource configuration.
      Parameters:
      context - the gateway context
      resource - the decoded resource holding the configuration
      Returns:
      the historian
      Throws:
      Exception - if the provider cannot be created