Class ServiceConnectorExtensionPoint<S, C extends ServiceConnector>

java.lang.Object
com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint<S>
com.inductiveautomation.ignition.gateway.serviceconnector.ServiceConnectorExtensionPoint<S,C>
Type Parameters:
S - The type of the settings object for this extension point.
C - The type of the service connector returned from createServiceConnector(DecodedResource).
All Implemented Interfaces:
ExtensionPoint<S>, Comparable<ExtensionPoint<S>>

public abstract class ServiceConnectorExtensionPoint<S, C extends ServiceConnector> extends AbstractExtensionPoint<S>
Base class for all Service Connector extension points.
  • Field Details

    • RESOURCE_TYPE

      public static final ResourceType RESOURCE_TYPE
  • Constructor Details

    • ServiceConnectorExtensionPoint

      public ServiceConnectorExtensionPoint(String typeId, String nameKey, String descriptionKey, String moduleId)
      Create a new service connector extension point.
      Parameters:
      typeId - The type ID of the service connector.
      nameKey - The i18n key for the name of the service connector.
      descriptionKey - The i18n key for the description of the service connector.
      moduleId - The module ID of the service connector.
  • Method Details

    • 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.
    • moduleId

      public final String moduleId()
      Get the module ID of the service connector.
    • createServiceConnector

      public abstract C createServiceConnector(DecodedResource<ExtensionPointConfig<ServiceConnectorProfile, ?>> decodedResource)
      Create a new service connector instance from the given resource. Use ExtensionPoint.getSettings(ExtensionPointConfig) to retrieve typed settings specific to this extension point.
      Parameters:
      decodedResource - The resource to create the service connector from.
      Returns:
      The new service connector instance.