Package com.inductiveautomation.ignition.gateway.serviceconnector

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(com.inductiveautomation.ignition.gateway.config.DecodedResource<com.inductiveautomation.ignition.gateway.config.ExtensionPointConfig<com.inductiveautomation.ignition.gateway.serviceconnector.ServiceConnectorProfile, ?>>).

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.

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
ServiceConnectorExtensionPoint(String typeId, String nameKey, String descriptionKey, String moduleId)	Create a new service connector extension point.

Method Summary

Modifier and Type	Method	Description
abstract C	createServiceConnector(DecodedResource<ExtensionPointConfig<ServiceConnectorProfile,?>> decodedResource)	Create a new service connector instance from the given resource.
final String	moduleId()	Get the module ID of the service connector.
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, buildGson, buildValidator, customizeGson, decode, description, encode, getReferenceFinders, 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, defaultSettings, getMenuActions, getSettings, getWebUiComponent, settingsSchema, settingsType

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(com.inductiveautomation.ignition.gateway.config.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.