Package com.inductiveautomation.ignition.gateway.opc

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>>

public abstract class OpcConnectionExtensionPoint<S>
extends AbstractExtensionPoint<S>

Base class for ExtensionPoints that provide an OpcConnection implementation.

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	The ResourceType used by all OPC Connections in the configuration resource collection.

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

Modifier	Constructor	Description
protected	OpcConnectionExtensionPoint(String typeId, String nameKey, String descriptionKey, @Nullable Class<S> settingsType)

Method Summary

Modifier and Type	Method	Description
final OpcConnection	create(GatewayContext context, OpcSubscriptionModel model, String name, ExtensionPointConfig<OpcConnectionConfig,?> config)
abstract OpcConnection	create(GatewayContext context, OpcSubscriptionModel model, String name, OpcConnectionConfig profileConfig, S extensionConfig)	Create a new OpcConnection of the type provided by this extension point.
Optional<Collection<Property<?>>>	getTagExtensionProperties()
Optional<Collection<Property<?>>>	getTagGroupExtensionProperties()
final ResourceType	resourceType()	The resource type shared by all types of this extension point.
Optional<Class<S>>	settingsType()

Methods inherited from class com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint

addReferenceProperty, buildGson, buildValidator, customizeGson, decode, description, encode, getReferenceProperties, 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

Field Details

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

The ResourceType used by all OPC Connections in the configuration resource collection.

Constructor Details

OpcConnectionExtensionPoint

protected OpcConnectionExtensionPoint(String typeId,
 String nameKey,
 String descriptionKey,
 @Nullable
 @Nullable Class<S> settingsType)

Method Details

settingsType

public Optional<Class<S>> 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 from ExtensionPoint.defaultSettings(), if one is provided.

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.

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 new OpcConnection of the type provided by this extension point.

Parameters:

context - the GatewayContext.

model - the Gateway's OpcSubscriptionModel.

profileConfig - configuration shared by all OPC connections.

extensionConfig - configuration for the type of connection created by this extension point.

Returns:

a new OpcConnection instance.

getTagExtensionProperties

public Optional<Collection<Property<?>>> getTagExtensionProperties()

getTagGroupExtensionProperties

public Optional<Collection<Property<?>>> getTagGroupExtensionProperties()