Class OpcConnectionExtensionPoint<S>
java.lang.Object
com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint<S>
com.inductiveautomation.ignition.gateway.opc.OpcConnectionExtensionPoint<S>
- Type Parameters:
S- the type of settings used by the OpcConnection provided by this extension point.
- All Implemented Interfaces:
ExtensionPoint<S>, Comparable<ExtensionPoint<S>>
Base class for
ExtensionPoints that provide an OpcConnection implementation.-
Nested Class Summary
Nested classes/interfaces inherited from interface ExtensionPoint
ExtensionPoint.ComponentType -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ResourceTypeTheResourceTypeused by all OPC Connections in the configuration resource collection.Fields inherited from class AbstractExtensionPoint
descriptionKey, gson, nameKey, typeId, validatorFields inherited from interface ExtensionPoint
PROFILE_KEY, SETTINGS_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal OpcConnectioncreate(GatewayContext context, OpcSubscriptionModel model, String name, ExtensionPointConfig<OpcConnectionConfig, ?> config) abstract OpcConnectioncreate(GatewayContext context, OpcSubscriptionModel model, String name, OpcConnectionConfig profileConfig, S extensionConfig) Create a newOpcConnectionof the type provided by this extension point.Returns the system tag contributor for this OPC connection type, if it publishes additional tags under the gateway's per-connection OPC system tag folder.Optional<Collection<Property<?>>> Optional<Collection<Property<?>>> voidonDelete(GatewayContext context, String name) Invoked once when a connection of this type is permanently deleted, after the connection'sLifecycle.shutdown()has run.final 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
-
Field Details
-
RESOURCE_TYPE
TheResourceTypeused by all OPC Connections in the configuration resource collection.
-
-
Constructor Details
-
OpcConnectionExtensionPoint
-
-
Method Details
-
settingsType
- Returns:
- the Class of the settings object for this ExtensionPoint, if it has one. If this
ExtensionPoint does not have settings, return
Optional.empty(). By default, this method returns the class of the object returned fromExtensionPoint.defaultSettings(), if one is provided.
-
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. -
create
public final OpcConnection create(GatewayContext context, OpcSubscriptionModel model, String name, ExtensionPointConfig<OpcConnectionConfig, ?> config) -
create
public abstract OpcConnection create(GatewayContext context, OpcSubscriptionModel model, String name, OpcConnectionConfig profileConfig, S extensionConfig) Create a newOpcConnectionof the type provided by this extension point.- Parameters:
context- theGatewayContext.model- the Gateway'sOpcSubscriptionModel.profileConfig- configuration shared by all OPC connections.extensionConfig- configuration for the type of connection created by this extension point.- Returns:
- a new
OpcConnectioninstance.
-
onDelete
Invoked once when a connection of this type is permanently deleted, after the connection'sLifecycle.shutdown()has run.This fires only on a genuine deletion of the connection's configuration resource — not on a disable, a reconfigure (delete-then-recreate of the same resource), a redundancy role-change restart, or gateway shutdown, all of which reuse the connection name and must keep durable per-connection state intact. An implementation can use it to reclaim durable per-connection state (for example, on-disk snapshots) keyed by
namethat must survive an ordinary restart but not the resource's deletion.The default implementation does nothing.
- Parameters:
context- theGatewayContext.name- the name of the connection being deleted.
-
getTagExtensionProperties
-
getTagGroupExtensionProperties
-
getSystemTagContributor
Returns the system tag contributor for this OPC connection type, if it publishes additional tags under the gateway's per-connection OPC system tag folder.- Returns:
- the optional system tag contributor.
-