Package com.inductiveautomation.ignition.gateway.opc

Interface OpcConnectionManager

All Superinterfaces:

ExtensionPointManager<OpcConnectionExtensionPoint<?>>

public interface OpcConnectionManager
extends ExtensionPointManager<OpcConnectionExtensionPoint<?>>

Manages OpcConnection instances and provides an interface to read, write, browse, and subscribe to OPC values via those connections.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	OpcConnectionManager.ConfiguredConnection	An OpcConnection and its associated resource and configuration.

Method Summary

Modifier and Type	Method	Description
List<OPCBrowseElement>	browse(ServerNodeId nodeId)	Browse the nodes immediately under the given node
OpcSubscription	createSubscription(String connectionName, String subscriptionName, PropertySet properties)	Create an OpcSubscription on the named connection.
void	deleteSubscription(OpcSubscription subscription)	Delete an OpcSubscription.
@Nullable OpcConnection	getConnection(String name)	Return the OpcConnection identified by name, or null if none exists.
List<OpcConnectionManager.ConfiguredConnection>	getConnections()	Get a List of all configured connections.
default OpcConnection.State	getConnectionState(String name)	Returns the OpcConnection.State of a named connection.
NamedResourceHandler<ExtensionPointConfig<OpcConnectionConfig,?>>	getResourceHandler()	Get the NamedResourceHandler managing OpcConnection resources.
OpcSubscriptionModel	getSubscriptionModel()	Get the OpcSubscriptionModel.
List<QualifiedValue>	read(List<ServerNodeId> nodes)	Reads the values addressed by the given nodes
List<QualityCode>	write(List<OPCWriteRequest> values)	Writes the values to their node ids

Methods inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPointManager

getExtensionPointCollection, getExtensionPointResourceType

Method Details

getResourceHandler

NamedResourceHandler<ExtensionPointConfig<OpcConnectionConfig,?>> getResourceHandler()

Get the NamedResourceHandler managing OpcConnection resources.

Returns:

the NamedResourceHandler managing OpcConnection resources.

getConnection

@Nullable
@Nullable OpcConnection getConnection(String name)

Return the OpcConnection identified by name, or null if none exists.

Parameters:

name - the name or alias for the OpcConnection.

Returns:

the OpcConnection identified by name, or null if none exists.

getConnections

List<OpcConnectionManager.ConfiguredConnection> getConnections()

Get a List of all configured connections.

Returns:

a List of all configured connections.

getConnectionState

default OpcConnection.State getConnectionState(String name)

Returns the OpcConnection.State of a named connection.

If the connection does not exist OpcConnection.State.UNKNOWN will be returned.

Parameters:

name - the name of the connection.

Returns:

the connection OpcConnection.State, or OpcConnection.State.UNKNOWN if the connection doesn't exist.

createSubscription

OpcSubscription createSubscription(String connectionName,
 String subscriptionName,
 PropertySet properties)
                            throws Exception

Create an OpcSubscription on the named connection.

Parameters:

connectionName - the name of the OpcConnection.

subscriptionName - the name to assign the OpcSubscription.

properties - a PropertySet containing additional properties that a subscription may need to configure itself.

Returns:

an OpcSubscription.

Throws:

Exception - if a subscription by subscriptionName already exists on the named connection.

deleteSubscription

void deleteSubscription(OpcSubscription subscription)

Delete an OpcSubscription.

Parameters:

subscription - the OpcSubscription to delete.

read

List<QualifiedValue> read(List<ServerNodeId> nodes)

Reads the values addressed by the given nodes

write

List<QualityCode> write(List<OPCWriteRequest> values)

Writes the values to their node ids

browse

List<OPCBrowseElement> browse(ServerNodeId nodeId)
                       throws Exception

Browse the nodes immediately under the given node

Throws:

Exception

getSubscriptionModel

OpcSubscriptionModel getSubscriptionModel()

Get the OpcSubscriptionModel.

This is the same instance provided to connections in OpcConnectionExtensionPoint.create(GatewayContext, OpcSubscriptionModel, String, OpcConnectionConfig, Object).