Class UaClient
- java.lang.Object
-
- com.plccom.opc.ua.application.StackClient
-
- com.plccom.opc.ua.client.application.UaClient
-
- All Implemented Interfaces:
SessionConnectionStateChangeListener,SessionKeepAliveListener,AutoCloseable
public class UaClient extends com.plccom.opc.ua.application.StackClient implements AutoCloseable, SessionKeepAliveListener, SessionConnectionStateChangeListener
PLCcom sdk OpcUaClient Implementation for Opc Ua- Author:
- Indi.An GmbH, www.indi-an.com, support@indi-an.com
-
-
Field Summary
Fields Modifier and Type Field Description static com.plccom.opc.ua.builtintypes.NodeId[]KNOWN_EVENT_TYPESWell-known OPC UA event type NodeIds that can be used for event filtering and event type identification.
-
Constructor Summary
Constructors Constructor Description UaClient(String user, String serial, ClientConfiguration sessionConfiguration)Construct a new client with default application and without security certificates
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description com.plccom.opc.ua.core.AddNodesResponseaddNodes(com.plccom.opc.ua.core.AddNodesItem... nodesToAdd)Synchronous AddNodes service request.com.plccom.opc.ua.core.AddNodesResponseaddNodes(com.plccom.opc.ua.core.AddNodesRequest req)Synchronous AddNodes service request.com.plccom.opc.ua.core.AddNodesResponseaddNodes(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.AddNodesItem... nodesToAdd)Synchronous AddNodes service request.voidaddNodesAsync(com.plccom.opc.ua.core.AddNodesItem[] nodesToAdd, AddNodesListener callback)Asynchronous AddNodes service request.voidaddNodesAsync(com.plccom.opc.ua.core.AddNodesRequest req, AddNodesListener callback)Asynchronous AddNodes service request.com.plccom.opc.ua.core.AddReferencesResponseaddReferences(com.plccom.opc.ua.core.AddReferencesItem... referencesToAdd)Synchronous AddReferences service request.com.plccom.opc.ua.core.AddReferencesResponseaddReferences(com.plccom.opc.ua.core.AddReferencesRequest req)Synchronous AddReferences service request.com.plccom.opc.ua.core.AddReferencesResponseaddReferences(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.AddReferencesItem... referencesToAdd)Synchronous AddReferences service request.voidaddReferencesAsync(com.plccom.opc.ua.core.AddReferencesItem[] referencesToAdd, AddReferencesListener callback)Asynchronous AddReferences service request.voidaddReferencesAsync(com.plccom.opc.ua.core.AddReferencesRequest req, AddReferencesListener callback)Asynchronous AddReferences service request.booleanaddSessionConnectionStateChangeListener(SessionConnectionStateChangeListener handler)append a SessionConnectionStateChangeListener object to event registerbooleanaddSessionKeepAliveListener(SessionKeepAliveListener handler)append a SessionKeepAliveListener object to event registercom.plccom.opc.ua.core.BrowseResponsebrowse(com.plccom.opc.ua.core.BrowseDescription... nodesToBrowse)Synchronous Browse service request.com.plccom.opc.ua.core.BrowseResponsebrowse(com.plccom.opc.ua.core.BrowseRequest req)Synchronous Browse service request.voidbrowseAsync(com.plccom.opc.ua.core.BrowseDescription[] nodesToBrowse, BrowseListener callback)Asynchronous Browse service request.voidbrowseAsync(com.plccom.opc.ua.core.BrowseDescription nodesToBrowse, BrowseListener callback)Asynchronous Browse service request.voidbrowseAsync(com.plccom.opc.ua.core.BrowseRequest req, BrowseListener callback)Asynchronous Browse service request.com.plccom.opc.ua.core.BrowseResponsebrowseFull(com.plccom.opc.ua.core.BrowseDescription... nodesToBrowse)Synchronous full Browse service request inclusive all necessary browseNext executions.com.plccom.opc.ua.core.BrowseResponsebrowseFull(com.plccom.opc.ua.core.BrowseRequest req)Synchronous full Browse service request inclusive all necessary browseNext executions.com.plccom.opc.ua.core.BrowseNextResponsebrowseNext(com.plccom.opc.ua.core.BrowseNextRequest req)This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.com.plccom.opc.ua.core.BrowseNextResponsebrowseNext(Boolean releaseContinuationPoints, com.plccom.opc.ua.builtintypes.ByteString... continuationPoints)This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.voidbrowseNextAsync(com.plccom.opc.ua.core.BrowseNextRequest req, BrowseListener callback)This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.voidbrowseNextAsync(Boolean releaseContinuationPoints, com.plccom.opc.ua.builtintypes.ByteString[] continuationPoints, BrowseListener callback)This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.voidbrowseNextAsync(Boolean releaseContinuationPoints, com.plccom.opc.ua.builtintypes.ByteString continuationPoints, BrowseListener callback)This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.static ReferenceDescriptionCollectionbrowseSuperTypes(com.plccom.opc.ua.application.SessionChannel sessionChannel, com.plccom.opc.ua.builtintypes.NodeId typeId, boolean throwOnError)Browses the address space and returns all of the supertypes of the specified type node.com.plccom.opc.ua.core.CallMethodResult[]call(com.plccom.opc.ua.core.CallMethodRequest... methodsToCall)Synchronous Call service requestcom.plccom.opc.ua.core.CallResponsecall(com.plccom.opc.ua.core.CallRequest req)Synchronous Call service request.com.plccom.opc.ua.core.CallMethodResult[]call(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.CallMethodRequest... methodsToCall)Synchronous Call service request.voidcallAsync(com.plccom.opc.ua.core.CallRequest req, CallListener callback)Asynchronous Call service request.com.plccom.opc.ua.core.CancelResponsecancel(com.plccom.opc.ua.builtintypes.UnsignedInteger requestHandle)Synchronous Cancel service request.com.plccom.opc.ua.core.CancelResponsecancel(com.plccom.opc.ua.core.CancelRequest req)Synchronous Cancel service request.com.plccom.opc.ua.core.CancelResponsecancel(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger requestHandle)Synchronous Cancel service request.voidcancelAsync(com.plccom.opc.ua.builtintypes.UnsignedInteger requestHandle, CancelListener callback)Asynchronous Cancel service request.voidcancelAsync(com.plccom.opc.ua.core.CancelRequest req, CancelListener callback)Asynchronous Cancel service request.voidcancelAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger requestHandle, CancelListener callback)Asynchronous Cancel service request.voidclose()disconnecting the Ua OpcUaClient instance from OPC Ua server and dispose this objectvoidconnect()connecting the Ua OpcUaClient instance to OPC Ua servervoidconnectReverse()Waits for an incoming ReverseHello with default timeout of 60 seconds.voidconnectReverse(int timeoutMs)Waits for an incoming ReverseHello from the server and establishes a session.com.plccom.opc.ua.application.SessioncreateSession(com.plccom.opc.ua.transport.SecureChannel channel, String sessionName)Create a new session on a serverUaSessionChannelcreateSessionChannel(com.plccom.opc.ua.core.EndpointDescription endpoint, String sessionName)Creates a secure channel and an unactivated session channel.UaSessionChannelcreateSessionChannel(String endpointUrl, String sessionName)Creates a secure channel and an unactivated session channel.UaSessionChannelcreateSessionChannel(String connectUrl, String endpointUri, String sessionName)Creates a secure channel and an unactivated session channel.com.plccom.opc.ua.core.HistoryUpdateResultdeleteAtTime(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime[] reqTimes)Deletes history values at the specified exact timestamps.com.plccom.opc.ua.core.HistoryUpdateResultdeleteAtTime(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime startTime, long numValuesPerNode, long timeStepMs)Deletes historical data at evenly spaced time intervals for the specified node.com.plccom.opc.ua.core.DeleteNodesResponsedeleteNodes(com.plccom.opc.ua.core.DeleteNodesItem... nodesToDelete)Synchronous DeleteNodes service request.com.plccom.opc.ua.core.DeleteNodesResponsedeleteNodes(com.plccom.opc.ua.core.DeleteNodesRequest req)Synchronous DeleteNodes service request.com.plccom.opc.ua.core.DeleteNodesResponsedeleteNodes(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.DeleteNodesItem... nodesToDelete)Synchronous DeleteNodes service request.voiddeleteNodesAsync(com.plccom.opc.ua.core.DeleteNodesItem[] nodesToDelete, DeleteNodesListener callback)Asynchronous DeleteNodes service request.voiddeleteNodesAsync(com.plccom.opc.ua.core.DeleteNodesRequest req, DeleteNodesListener callback)Asynchronous DeleteNodes service request.com.plccom.opc.ua.core.HistoryUpdateResultdeleteRaw(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, boolean isModified)Deletes raw historical data for the specified node within the given time range.com.plccom.opc.ua.core.DeleteReferencesResponsedeleteReferences(com.plccom.opc.ua.core.DeleteReferencesItem... referencesToDelete)Synchronous DeleteReferences service request.com.plccom.opc.ua.core.DeleteReferencesResponsedeleteReferences(com.plccom.opc.ua.core.DeleteReferencesRequest req)Synchronous DeleteReferences service request.com.plccom.opc.ua.core.DeleteReferencesResponsedeleteReferences(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.DeleteReferencesItem... referencesToDelete)Synchronous DeleteReferences service request.voiddeleteReferencesAsync(com.plccom.opc.ua.core.DeleteReferencesItem[] referencesToDelete, DeleteReferencesListener callback)Asynchronous DeleteReferences service request.voiddeleteReferencesAsync(com.plccom.opc.ua.core.DeleteReferencesRequest req, DeleteReferencesListener callback)Asynchronous DeleteReferences service request.voiddisconnect()Deprecated.Use close() insteadstatic com.plccom.opc.ua.core.EndpointDescription[]discoverAllEndpoints(URI discoveryEndpointUri)Gets all endpoints on the opc ua server, regardless of transport protocol.static com.plccom.opc.ua.core.EndpointDescription[]discoverAllEndpoints(URI discoveryEndpointUri, com.plccom.opc.ua.transport.security.CertificateValidator certificateValidator)Gets all endpoints on the opc ua server, regardless of transport protocol.static com.plccom.opc.ua.core.EndpointDescription[]discoverEndpoints(String hostName, int port)Gets endpoints on the opc ua serverstatic com.plccom.opc.ua.core.EndpointDescription[]discoverEndpoints(String hostName, int port, String instanceName)Gets endpoints on the opc ua serverstatic com.plccom.opc.ua.core.EndpointDescription[]discoverEndpoints(URI discoveryEndpointUri)Gets endpoints on the opc ua server, filtered to match the transport protocol of the discovery URL.static com.plccom.opc.ua.core.EndpointDescription[]discoverEndpoints(URI discoveryEndpointUri, com.plccom.opc.ua.transport.security.CertificateValidator certificateValidator)Gets endpoints on the opc ua server, filtered to match the transport protocol of the discovery URL.static StringendpointToString(com.plccom.opc.ua.core.EndpointDescription endpoint)Deprecated.static com.plccom.opc.ua.core.EndpointDescription[]filterEndpoints(com.plccom.opc.ua.core.EndpointDescription[] endpoints, EndpointProtocol endpointProtocol, SortDirection sortDirection)Filter all EndpointDescriptions by protocolstatic com.plccom.opc.ua.core.EndpointDescription[]filterEndpoints(com.plccom.opc.ua.core.EndpointDescription[] endpoints, EndpointProtocol endpointProtocol, com.plccom.opc.ua.core.MessageSecurityMode messageSecurityMode, SortDirection sortDirection)Filter all EndpointDescriptions by protocolstatic com.plccom.opc.ua.core.EndpointDescription[]filterEndpoints(com.plccom.opc.ua.core.EndpointDescription[] endpoints, EndpointProtocol endpointProtocol, com.plccom.opc.ua.core.MessageSecurityMode messageSecurityMode, com.plccom.opc.ua.transport.security.SecurityPolicy securityPolicy, SortDirection sortDirection)Filter all EndpointDescriptions by protocolstatic com.plccom.opc.ua.core.EndpointDescriptionfindBestEndpoint(URI discoveryUrl, EndpointProtocol endpointProtocol, com.plccom.opc.ua.core.MessageSecurityMode messageSecurityMode)get endpoint by discoveryUrl, and find the best endpoint by endpoint protocol and message security modestatic com.plccom.opc.ua.core.EndpointDescriptionfindBestEndpoint(URI discoveryUrl, com.plccom.opc.ua.core.MessageSecurityMode messageSecurityMode)select a custom endpoint by discoveryUrl, with or without security modestatic com.plccom.opc.ua.core.EndpointDescriptionfindBestEndpoint(URI discoveryUrl, URI knownEndpointUrl, com.plccom.opc.ua.core.MessageSecurityMode messageSecurityMode)get endpoint by discoveryUrl, and find the best endpoint by known endpoint urlstatic com.plccom.opc.ua.builtintypes.NodeIdfindConditionInstanceNode(MonitoredItem monitoredItem, com.plccom.opc.ua.core.EventFieldList notification)Finds the type of the event for the notification.static com.plccom.opc.ua.builtintypes.NodeIdfindEventElement(MonitoredItem monitoredItem, com.plccom.opc.ua.core.EventFieldList notification, BrowseNames browseName)Finds the type of the event for the notification.static com.plccom.opc.ua.builtintypes.NodeIdfindEventType(MonitoredItem monitoredItem, com.plccom.opc.ua.core.EventFieldList notification)Finds the EventType NodeId from an event notification by searching the select clauses of the monitored item's event filter for the "EventType" field.static com.plccom.opc.ua.core.ApplicationDescription[]findServer(String discoverServerEndpointUrl)Discover applicationsstatic com.plccom.opc.ua.core.ApplicationDescription[]findServer(String connectUrl, String discoverServerEndpointUri)Discover applicationsstatic voidfindServerAsync(String connectUrl, String discoverServerEndpointUri, FindServerListener callback)Discover applicationsUaComplexTypeSystemgetComplexTypeSystem()Creates a newUaComplexTypeSystemfor this client session.StringgetLicenceMessage()returns the current licence message with actual detailscom.plccom.opc.ua.common.NamespaceTablegetNamespaceUris()Returns the namespace table known to the current session.com.plccom.opc.ua.builtintypes.UnsignedIntegergetNextRequestHandle()function returns the nextUnsignedIntegerfrom a atomic sequence, for using as unique request handleUaNodeCachegetNodeCache()Returns the internal node cachecom.plccom.opc.ua.builtintypes.NodeIdgetNodeIdByPath(String browsePath)Returns a mNodeId from provided Opc Ua browse pathcom.plccom.opc.ua.builtintypes.NodeIdgetNodeIdByPath(ArrayList<com.plccom.opc.ua.builtintypes.QualifiedName> browsePath)Returns a mNodeId by given Opc Ua pathArrayList<String>getPathByNodeId(com.plccom.opc.ua.builtintypes.ExpandedNodeId expandednodeId)Returns aArrayListof logical paths from providedNodeIdArrayList<String>getPathByNodeId(com.plccom.opc.ua.builtintypes.NodeId nodeid)Returns aArrayListof logical paths from providedNodeIdcom.plccom.opc.ua.core.ReferenceDescriptiongetReferenceDescriptionByNodeId(com.plccom.opc.ua.builtintypes.NodeId nodeId)Returns a ReferenceDescription by provided NodeIdcom.plccom.opc.ua.core.ReferenceDescriptiongetReferenceDescriptionByPath(String browsePath)Returns a ReferenceDescription by provided Opc Ua browse pathcom.plccom.opc.ua.core.ReferenceDescriptiongetReferenceDescriptionByPath(ArrayList<com.plccom.opc.ua.builtintypes.QualifiedName> browsePath)Returns a ReferenceDescription by provided Opc Ua browse pathchargetSeparator()return current path separator (usually '.')com.plccom.opc.ua.common.ServerTablegetServerUris()Returns the server URI table known to the current session.UaSessionChannelgetSessionChannel()Returns actual SessionChannelClientConfigurationgetSessionConfiguration()Returns the current SessionConfigurationdoublegetSessionTimeout()Returns the negotiated session timeout in milliseconds.UaSubscriptionManagergetSubscriptionManager()Gets the internalUaSubscriptionManagerUaAddressSpacegetUaAddressSpace()Returns the internal Ua adress spaceUaNodegetUaNode(com.plccom.opc.ua.builtintypes.ExpandedNodeId expandedNodeId)Returns a class derived from UaNode with extended fields and informations about the expandedNodeIdUaNodegetUaNode(com.plccom.opc.ua.builtintypes.ExpandedNodeId expandedNodeId, com.plccom.opc.ua.builtintypes.NodeId nodetype)Returns a class derived from UaNode with extended fields and informations about the expandedNodeIdUaNodegetUaNode(com.plccom.opc.ua.builtintypes.NodeId nodeid)Returns a class derived from UaNode with extended fields and informations about the NodeIdUaNodegetUaNode(com.plccom.opc.ua.builtintypes.NodeId nodeid, com.plccom.opc.ua.builtintypes.NodeId nodetype)Returns a class derived from UaNode with extended fields and informations about the NodeIdUaNodegetUaNode(com.plccom.opc.ua.core.ReferenceDescription referenceDescription)Returns a class derived from UaNode with extended fields and informations about the ReferenceDescriptionUaNodegetUaNode(com.plccom.opc.ua.core.ReferenceDescription referenceDescription, com.plccom.opc.ua.builtintypes.NodeId nodetype)Returns a class derived from UaNode with extended fields and informations about the ReferenceDescriptioncom.plccom.opc.ua.core.HistoryReadResponsehistoryRead(com.plccom.opc.ua.builtintypes.ExtensionObject historyReadDetails, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, Boolean releaseContinuationPoints, com.plccom.opc.ua.core.HistoryReadValueId... nodesToRead)Read synchronously one or more historical values or historical events from servercom.plccom.opc.ua.core.HistoryReadResponsehistoryRead(com.plccom.opc.ua.core.HistoryReadRequest req)Read synchronously one or more historical values or historical events from servervoidhistoryReadAsync(com.plccom.opc.ua.builtintypes.ExtensionObject historyReadDetails, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, Boolean releaseContinuationPoints, com.plccom.opc.ua.core.HistoryReadValueId[] nodesToRead, HistoryReadListener callback)Read asynchronously one or more historical values or historical events from servervoidhistoryReadAsync(com.plccom.opc.ua.builtintypes.ExtensionObject historyReadDetails, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, Boolean releaseContinuationPoints, com.plccom.opc.ua.core.HistoryReadValueId nodesToRead, HistoryReadListener callback)Read asynchronously one historical values or historical events from servervoidhistoryReadAsync(com.plccom.opc.ua.core.HistoryReadRequest req, HistoryReadListener callback)Read asynchronously one or more historical values or historical events from servercom.plccom.opc.ua.core.HistoryUpdateResponsehistoryUpdate(com.plccom.opc.ua.builtintypes.ExtensionObject... historyUpdateDetails)Update synchronously one or more historical values or historical events at servercom.plccom.opc.ua.core.HistoryUpdateResponsehistoryUpdate(com.plccom.opc.ua.core.HistoryUpdateRequest req)Update synchronously one or more historical values or historical events at servervoidhistoryUpdateAsync(com.plccom.opc.ua.builtintypes.ExtensionObject[] historyUpdateDetails, HistoryUpdateListener callback)Update asynchronously one or more historical values or historical events at servervoidhistoryUpdateAsync(com.plccom.opc.ua.builtintypes.ExtensionObject historyUpdateDetails, HistoryUpdateListener callback)Update asynchronously one or more historical values or historical events at servervoidhistoryUpdateAsync(com.plccom.opc.ua.core.HistoryUpdateRequest req, HistoryUpdateListener callback)Update asynchronously one or more historical values or historical events at servercom.plccom.opc.ua.core.HistoryUpdateResultinsertHistoryValues(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DataValue[] values)Inserts new historical data values for the specified node.booleanisConnected()Returns whether the session is currently connected to the OPC UA server.booleanisTolerateFaultyServerState()Returns whether the client tolerates a server that reports a state other than "Running".voidmodifySessionConfiguration(ClientConfiguration clientConfiguration, boolean reconnect)Replaces the current session configuration and optionally reconnects to the server.voidonSessionConnectionStateChanged(boolean isConnected)event is called when the connection state of session changesvoidonSessionKeepAlive(com.plccom.opc.ua.core.ServerStatusDataType serverStatusDataType, com.plccom.opc.ua.core.ServerState serverState)the event OnSessionKeepAlive by every server keepalive eventcom.plccom.opc.ua.core.PublishResponsepublish(com.plccom.opc.ua.core.PublishRequest req)Synchronous Publish service request.com.plccom.opc.ua.core.PublishResponsepublish(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.SubscriptionAcknowledgement... subscriptionAcknowledgements)Synchronous Publish service request.com.plccom.opc.ua.core.PublishResponsepublish(com.plccom.opc.ua.core.SubscriptionAcknowledgement... subscriptionAcknowledgements)Synchronous Publish service request.voidpublishAsync(com.plccom.opc.ua.core.PublishRequest req, PublishListener callback)Asynchronous Publish service request.voidpublishAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.SubscriptionAcknowledgement[] subscriptionAcknowledgements, PublishListener callback)Asynchronous Publish service request.voidpublishAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.SubscriptionAcknowledgement subscriptionAcknowledgement, PublishListener callback)Asynchronous Publish service request.voidpublishAsync(com.plccom.opc.ua.core.SubscriptionAcknowledgement[] subscriptionAcknowledgements, PublishListener callback)Asynchronous Publish service request.voidpublishAsync(com.plccom.opc.ua.core.SubscriptionAcknowledgement subscriptionAcknowledgement, PublishListener callback)Asynchronous Publish service request.com.plccom.opc.ua.core.QueryFirstResponsequeryFirst(com.plccom.opc.ua.core.QueryFirstRequest req)Synchronous QueryFirst service request.com.plccom.opc.ua.core.QueryFirstResponsequeryFirst(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.ViewDescription view, com.plccom.opc.ua.core.NodeTypeDescription[] nodeTypes, com.plccom.opc.ua.core.ContentFilter filter, com.plccom.opc.ua.builtintypes.UnsignedInteger maxDataSetsToReturn, com.plccom.opc.ua.builtintypes.UnsignedInteger maxReferencesToReturn)Synchronous QueryFirst service request.com.plccom.opc.ua.core.QueryFirstResponsequeryFirst(com.plccom.opc.ua.core.ViewDescription view, com.plccom.opc.ua.core.NodeTypeDescription[] nodeTypes, com.plccom.opc.ua.core.ContentFilter filter, com.plccom.opc.ua.builtintypes.UnsignedInteger maxDataSetsToReturn, com.plccom.opc.ua.builtintypes.UnsignedInteger maxReferencesToReturn)Synchronous QueryFirst service request.voidqueryFirstAsync(com.plccom.opc.ua.core.QueryFirstRequest req, QueryFirstListener callback)Asynchronous QueryFirst service request.voidqueryFirstAsync(com.plccom.opc.ua.core.ViewDescription view, com.plccom.opc.ua.core.NodeTypeDescription[] nodeTypes, com.plccom.opc.ua.core.ContentFilter filter, com.plccom.opc.ua.builtintypes.UnsignedInteger maxDataSetsToReturn, com.plccom.opc.ua.builtintypes.UnsignedInteger maxReferencesToReturn, QueryFirstListener callback)Asynchronous QueryFirst service request.com.plccom.opc.ua.core.QueryNextResponsequeryNext(com.plccom.opc.ua.core.QueryNextRequest req)Synchronous QueryNext service request.com.plccom.opc.ua.core.QueryNextResponsequeryNext(com.plccom.opc.ua.core.RequestHeader requestHeader, Boolean releaseContinuationPoint, com.plccom.opc.ua.builtintypes.ByteString continuationPoint)Synchronous QueryNext service request.com.plccom.opc.ua.core.QueryNextResponsequeryNext(Boolean releaseContinuationPoint, com.plccom.opc.ua.builtintypes.ByteString continuationPoint)Synchronous QueryNext service request.voidqueryNextAsync(com.plccom.opc.ua.core.QueryNextRequest req, QueryNextListener callback)Asynchronous QueryNext service request.voidqueryNextAsync(Boolean releaseContinuationPoint, com.plccom.opc.ua.builtintypes.ByteString continuationPoint, QueryNextListener callback)Asynchronous QueryNext service request.com.plccom.opc.ua.core.ReadResponseread(com.plccom.opc.ua.builtintypes.NodeId[] nodeIdsToRead, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId)Read synchronously attributes or values of one or more NodeIdscom.plccom.opc.ua.core.ReadResponseread(com.plccom.opc.ua.builtintypes.NodeId[] nodeIdsToRead, UaAttributes attribute)Read synchronously attributes or values of one or more NodeIdscom.plccom.opc.ua.core.ReadResponseread(com.plccom.opc.ua.builtintypes.NodeId nodeIdToRead, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId)Read synchronously attributes or values of one or more NodeIdscom.plccom.opc.ua.core.ReadResponseread(com.plccom.opc.ua.builtintypes.NodeId nodeIdToRead, UaAttributes attribute)Read synchronously attributes or values of one or more NodeIdscom.plccom.opc.ua.core.ReadResponseread(com.plccom.opc.ua.core.ReadRequest req)Read synchronously one attributes or values of one or more nodes.com.plccom.opc.ua.core.ReadResponseread(com.plccom.opc.ua.core.ReadValueId... nodesToRead)Read synchronously one attributes or values of one or more nodes.com.plccom.opc.ua.core.ReadResponseread(Double maxAge, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, com.plccom.opc.ua.core.ReadValueId... nodesToRead)Read synchronously one attributes or values of one or more nodes.voidreadAsync(com.plccom.opc.ua.builtintypes.NodeId[] nodeIdsToRead, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId, ReadListener callback)Read asynchronously one attributes or values of one or more nodes.voidreadAsync(com.plccom.opc.ua.builtintypes.NodeId nodeIdToRead, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId, ReadListener callback)Read asynchronously one attributes or values of a node.voidreadAsync(com.plccom.opc.ua.core.ReadRequest req, ReadListener callback)Read asynchronously one attributes or values of one or more nodes.voidreadAsync(com.plccom.opc.ua.core.ReadValueId[] nodesToRead, ReadListener callback)Read asynchronously one attributes or values of one or more nodes.voidreadAsync(com.plccom.opc.ua.core.ReadValueId nodeToRead, ReadListener callback)Read asynchronously one attributes or values of a node.voidreadAsync(Double maxAge, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, com.plccom.opc.ua.core.ReadValueId[] nodesToRead, ReadListener callback)Read asynchronously one attributes or values of one or more nodes.voidreadAsync(Double maxAge, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, com.plccom.opc.ua.core.ReadValueId nodesToRead, ReadListener callback)Read asynchronously one attributes or values of one or more nodes.com.plccom.opc.ua.core.HistoryDatareadAtTime(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime startTime, long numValuesPerNode, long timeStepMs, boolean useSimpleBounds)Reads historical data at evenly spaced time intervals for a single node.com.plccom.opc.ua.core.HistoryReadResponsereadAtTime(com.plccom.opc.ua.core.HistoryReadValueId[] nodesToRead, com.plccom.opc.ua.builtintypes.DateTime startTime, long numValuesPerNode, long timeStepMs, boolean useSimpleBounds)Reads historical data at evenly spaced time intervals for multiple nodes.com.plccom.opc.ua.core.ReadResponsereadFullNode(com.plccom.opc.ua.builtintypes.NodeId nodeId)Reads all base attributes of a node from the OPC UA server, including NodeId, NodeClass, BrowseName, DisplayName, Description, WriteMask and UserWriteMask.com.plccom.opc.ua.core.ReadResponsereadFullNode(String browsePath)Reads all base attributes of a node identified by its browse path string.com.plccom.opc.ua.core.ReadResponsereadFullNode(ArrayList<com.plccom.opc.ua.builtintypes.QualifiedName> browsePath)Reads all base attributes of a node identified by its browse path.com.plccom.opc.ua.core.HistoryDatareadProcessed(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.NodeId aggregate, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, double processingInterval)Reads processed (aggregated) historical data for a single node.com.plccom.opc.ua.core.HistoryReadResponsereadProcessed(com.plccom.opc.ua.core.HistoryReadValueId[] nodesToRead, com.plccom.opc.ua.builtintypes.NodeId aggregate, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, double processingInterval)Reads processed (aggregated) historical data for multiple nodes.com.plccom.opc.ua.core.HistoryDatareadRaw(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, boolean isReadModified)Reads raw historical data for a single node within the specified time range.com.plccom.opc.ua.core.HistoryDatareadRaw(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, com.plccom.opc.ua.builtintypes.UnsignedInteger numValuesPerNode, boolean isReadModified)Reads raw historical data for a single node within the specified time range with an optional limit on the number of returned values.com.plccom.opc.ua.core.HistoryReadResponsereadRaw(com.plccom.opc.ua.core.HistoryReadValueId[] nodesToRead, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, com.plccom.opc.ua.builtintypes.UnsignedInteger numValuesPerNode, boolean isReadModified)Reads raw historical data for multiple nodes within the specified time range.com.plccom.opc.ua.core.ReadResponsereadValue(com.plccom.opc.ua.builtintypes.NodeId... NodeIdsToRead)Read synchronously values of one or more NodeIdsvoidreadValueAsync(com.plccom.opc.ua.builtintypes.NodeId nodeIdToRead, ReadListener callback)Read asynchronously the value of a nodecom.plccom.opc.ua.core.ReadResponsereadValues(com.plccom.opc.ua.builtintypes.NodeId[] nodeIds)Reads the current values of multiple variable nodes from the OPC UA server.voidreadValuesAsync(com.plccom.opc.ua.builtintypes.NodeId[] nodeIdsToRead, ReadListener callback)Read asynchronously the values of one or more nodesvoidreconnect()reconnecting the Ua OpcUaClient instance to OPC Ua servervoidrefreshConditions(UaSubscription subscription)Triggers a condition refresh on the specified subscription, causing the server to resend the current state of all active conditions.com.plccom.opc.ua.core.RegisterNodesResponseregisterNodes(com.plccom.opc.ua.builtintypes.NodeId... nodesToRegister)The RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g.com.plccom.opc.ua.core.RegisterNodesResponseregisterNodes(com.plccom.opc.ua.core.RegisterNodesRequest req)The RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g.com.plccom.opc.ua.core.RegisterNodesResponseregisterNodes(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.NodeId... nodesToRegister)The RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g.voidregisterNodesAsync(com.plccom.opc.ua.builtintypes.NodeId[] nodesToRegister, RegisterNodesListener callback)The RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g.voidregisterNodesAsync(com.plccom.opc.ua.core.RegisterNodesRequest req, RegisterNodesListener callback)The RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g.voidregisterNodesAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.NodeId[] nodesToRegister, RegisterNodesListener callback)The RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g.com.plccom.opc.ua.core.HistoryUpdateResultremoveHistoryValues(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DataValue[] values)Removes historical data values at the specified timestamps for the given node.booleanremoveSessionConnectionStateChangeListener(SessionConnectionStateChangeListener handler)remove a SessionConnectionStateChangeListener object from event registerbooleanremoveSessionKeepAliveListener(SessionKeepAliveListener handler)remove a SessionKeepAliveListener object from event registercom.plccom.opc.ua.core.HistoryUpdateResultreplaceHistoryValues(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DataValue[] values)Replaces existing historical data values for the specified node.com.plccom.opc.ua.core.RepublishResponserepublish(com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger retransmitSequenceNumber)Synchronous Republish service request.com.plccom.opc.ua.core.RepublishResponserepublish(com.plccom.opc.ua.core.RepublishRequest req)Synchronous Republish service request.com.plccom.opc.ua.core.RepublishResponserepublish(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger retransmitSequenceNumber)Synchronous Republish service request.voidrepublishAsync(com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger retransmitSequenceNumber, RepublishListener callback)Asynchronous Republish service request.voidrepublishAsync(com.plccom.opc.ua.core.RepublishRequest req, RepublishListener callback)Asynchronous Republish service request.voidrepublishAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger retransmitSequenceNumber, RepublishListener callback)Asynchronous Republish service request.voidsetSeparator(char value)set the path separator (usually '.')voidsetTolerateFaultyServerState(boolean value)Sets whether the client tolerates a server that reports a state other than "Running".com.plccom.opc.ua.core.SetTriggeringResponsesetTriggering(com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger triggeringItemId, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToAdd, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToRemove)Synchronous SetTriggering service request.com.plccom.opc.ua.core.SetTriggeringResponsesetTriggering(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger triggeringItemId, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToAdd, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToRemove)Synchronous SetTriggering service request.com.plccom.opc.ua.core.SetTriggeringResponsesetTriggering(com.plccom.opc.ua.core.SetTriggeringRequest req)Synchronous SetTriggering service request.voidsetTriggeringAsync(com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger triggeringItemId, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToAdd, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToRemove, SetTriggeringListener callback)Asynchronous SetTriggering service request.voidsetTriggeringAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger triggeringItemId, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToAdd, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToRemove, SetTriggeringListener callback)Asynchronous SetTriggering service request.voidsetTriggeringAsync(com.plccom.opc.ua.core.SetTriggeringRequest req, SetTriggeringListener callback)Asynchronous SetTriggering service request.static com.plccom.opc.ua.core.EndpointDescription[]sortBySecurityLevel(com.plccom.opc.ua.core.EndpointDescription[] endpoints, SortDirection sortDirection)Sorts endpoints by their security level.voidstartReverseConnectListener(String listenUrl)Configures the URL on which this client listens for incoming Reverse Connect connections from the server.voidstopReverseConnectListener()Resets the reverse connect listener configuration.static StringsubscriptionToString(UaSubscription subscription)Deprecated.UseOpcUaDisplayUtils.toDisplayString(UaSubscription)instead.com.plccom.opc.ua.core.TransferSubscriptionsResponsetransferSubscriptions(com.plccom.opc.ua.builtintypes.UnsignedInteger[] subscriptionIds, Boolean sendInitialValues)Synchronous TransferSubscriptions service request.com.plccom.opc.ua.core.TransferSubscriptionsResponsetransferSubscriptions(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger[] subscriptionIds, Boolean sendInitialValues)Synchronous TransferSubscriptions service request.com.plccom.opc.ua.core.TransferSubscriptionsResponsetransferSubscriptions(com.plccom.opc.ua.core.TransferSubscriptionsRequest req)Synchronous TransferSubscriptions service request.voidtransferSubscriptionsAsync(com.plccom.opc.ua.builtintypes.UnsignedInteger[] subscriptionIds, Boolean sendInitialValues, TransferSubscriptionsListener callback)Asynchronous TransferSubscriptions service request.voidtransferSubscriptionsAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger[] subscriptionIds, Boolean sendInitialValues, TransferSubscriptionsListener callback)Asynchronous TransferSubscriptions service request.voidtransferSubscriptionsAsync(com.plccom.opc.ua.core.TransferSubscriptionsRequest req, TransferSubscriptionsListener callback)Asynchronous TransferSubscriptions service request.com.plccom.opc.ua.core.TranslateBrowsePathsToNodeIdsResponsetranslateBrowsePathsToNodeIds(com.plccom.opc.ua.core.BrowsePath... browsePaths)With this service translates the server synchronously one or more browse paths to mNodeId�scom.plccom.opc.ua.core.TranslateBrowsePathsToNodeIdsResponsetranslateBrowsePathsToNodeIds(com.plccom.opc.ua.core.TranslateBrowsePathsToNodeIdsRequest req)With this service translates the server synchronously one or more browse paths to mNodeId�svoidtranslateBrowsePathsToNodeIdsAsync(com.plccom.opc.ua.core.BrowsePath[] browsePaths, TranslateBrowsePathsToNodeIdsListener callback)With this service translates the server asynchronously one or more browse paths to mNodeId�svoidtranslateBrowsePathsToNodeIdsAsync(com.plccom.opc.ua.core.BrowsePath browsePaths, TranslateBrowsePathsToNodeIdsListener callback)With this service translates the server asynchronously one or more browse paths to mNodeId�svoidtranslateBrowsePathsToNodeIdsAsync(com.plccom.opc.ua.core.TranslateBrowsePathsToNodeIdsRequest req, TranslateBrowsePathsToNodeIdsListener callback)With this service translates the server asynchronously one or more browse paths to mNodeId�scom.plccom.opc.ua.core.UnregisterNodesResponseunregisterNodes(com.plccom.opc.ua.builtintypes.NodeId... nodesToUnRegister)The UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g.com.plccom.opc.ua.core.UnregisterNodesResponseunregisterNodes(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.NodeId... nodesToUnRegister)The UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g.com.plccom.opc.ua.core.UnregisterNodesResponseunregisterNodes(com.plccom.opc.ua.core.UnregisterNodesRequest req)The UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g.voidunregisterNodesAsync(com.plccom.opc.ua.builtintypes.NodeId[] nodesToUnregister, UnregisterNodesListener callback)The UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g.voidunregisterNodesAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.NodeId[] nodesToUnregister, UnregisterNodesListener callback)The UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g.voidunregisterNodesAsync(com.plccom.opc.ua.core.UnregisterNodesRequest req, UnregisterNodesListener callback)The UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g.com.plccom.opc.ua.core.HistoryUpdateResultupdateHistoryValues(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DataValue[] values)Updates existing historical data values for the specified node.com.plccom.opc.ua.builtintypes.StatusCodewrite(com.plccom.opc.ua.builtintypes.NodeId nodeToWrite, Object valueToWrite, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId)Write synchronously attribute or value to a nodes.com.plccom.opc.ua.builtintypes.StatusCodewrite(com.plccom.opc.ua.builtintypes.NodeId nodeToWrite, Object valueToWrite, UaAttributes attribute)Write synchronously attribute or value to a nodes.com.plccom.opc.ua.core.WriteResponsewrite(UaWriteValue... nodesToWrite)Write synchronously attributes or values to one or more nodes.com.plccom.opc.ua.core.WriteResponsewrite(com.plccom.opc.ua.core.WriteRequest req)Write synchronously attributes or values to one or more nodes.voidwriteAsync(com.plccom.opc.ua.builtintypes.NodeId nodeToWrite, Object valueToWrite, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId, WriteListener callback)Write asynchronously attributes or values to a node.voidwriteAsync(UaWriteValue[] nodesToWrite, WriteListener callback)Write asynchronously attributes or values to one or more nodes.voidwriteAsync(UaWriteValue nodesToWrite, WriteListener callback)Write asynchronously attributes or values to one node.voidwriteAsync(com.plccom.opc.ua.core.WriteRequest req, WriteListener callback)Write asynchronously attributes or values to one or more nodes.com.plccom.opc.ua.builtintypes.StatusCodewriteValue(com.plccom.opc.ua.builtintypes.NodeId nodeToWrite, Object valueToWrite)Write synchronously attribute or value to a nodes with attributeId ValuevoidwriteValueAsync(com.plccom.opc.ua.builtintypes.NodeId nodeToWrite, Object valueToWrite, WriteListener callback)Write asynchronously attributes or values to a node.-
Methods inherited from class com.plccom.opc.ua.application.StackClient
createSecureChannel, discoverApplications, discoverApplications, discoverEndpoints, discoverEndpoints, discoverServersOnNetwork, discoverServersOnNetwork, discoverServersOnNetwork, discoverServersOnNetwork, getApplication, getApplicationHttpsSettings, getApplicatioOpcTcpSettings, getEncoderContext, getEndpointConfiguration, getMaxMessageSize, getTimeout, setEndpointConfiguration, setMaxMessageSize, setTimeout
-
-
-
-
Constructor Detail
-
UaClient
public UaClient(String user, String serial, ClientConfiguration sessionConfiguration)
Construct a new client with default application and without security certificates- Parameters:
user- a String with current user name from your licence informationserial- a String with current serial from your licence informationsessionConfiguration- aClientConfigurationfor creating a UaClient
-
-
Method Detail
-
getSubscriptionManager
public final UaSubscriptionManager getSubscriptionManager()
Gets the internalUaSubscriptionManager- Returns:
- the internal
UaSubscriptionManager
-
isConnected
public boolean isConnected()
Returns whether the session is currently connected to the OPC UA server.- Returns:
trueif the session is connected,falseotherwise
-
reconnect
public void reconnect()
reconnecting the Ua OpcUaClient instance to OPC Ua server
-
close
public void close() throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptiondisconnecting the Ua OpcUaClient instance from OPC Ua server and dispose this objectThis permanently stops the internal session watchdog; the instance cannot be connected again - create a new UaClient instead.
- Specified by:
closein interfaceAutoCloseable- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
getNodeIdByPath
public com.plccom.opc.ua.builtintypes.NodeId getNodeIdByPath(ArrayList<com.plccom.opc.ua.builtintypes.QualifiedName> browsePath) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Returns a mNodeId by given Opc Ua path- Parameters:
browsePath- a List of fully-qualified browse path from the target. You can specify a subfolder by using a dot delimited name. E.g: the tag 'foo.bar' finds the tag `bar` on the folder 'foo'- Returns:
- a mNodeId object, null when browse path not exist
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
getNodeIdByPath
public com.plccom.opc.ua.builtintypes.NodeId getNodeIdByPath(String browsePath) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Returns a mNodeId from provided Opc Ua browse path- Parameters:
browsePath- fully-qualified browse path of the target. You can specify a subfolder by using a dot delimited name. E.g: the tag 'foo.bar' finds the tag 'bar' on the folder 'foo'- Returns:
- a mNodeId object, null when browse path not exist
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
getReferenceDescriptionByNodeId
public com.plccom.opc.ua.core.ReferenceDescription getReferenceDescriptionByNodeId(com.plccom.opc.ua.builtintypes.NodeId nodeId) throws com.plccom.opc.ua.common.ServiceResultExceptionReturns a ReferenceDescription by provided NodeId- Parameters:
nodeId- mNodeId of the target.- Returns:
- a ReferenceDescription object, null when nodeId not exist
- Throws:
com.plccom.opc.ua.common.ServiceResultException- on communication error
-
getReferenceDescriptionByPath
public com.plccom.opc.ua.core.ReferenceDescription getReferenceDescriptionByPath(ArrayList<com.plccom.opc.ua.builtintypes.QualifiedName> browsePath) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Returns a ReferenceDescription by provided Opc Ua browse path- Parameters:
browsePath- a List of fully-qualified browse path fronm the target. You can specify a subfolder by using a dot delimited name. E.g: the tag 'foo.bar' finds the tag 'bar' on the folder 'foo'- Returns:
- a ReferenceDescription object, null when browse path not exist
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
getReferenceDescriptionByPath
public com.plccom.opc.ua.core.ReferenceDescription getReferenceDescriptionByPath(String browsePath) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Returns a ReferenceDescription by provided Opc Ua browse path- Parameters:
browsePath- fully-qualified browse path of the target. You can specify a subfolder by using a dot delimited name. E.g: the tag 'foo.bar' finds the tag 'bar' on the folder 'foo'- Returns:
- a ReferenceDescription object, null when browse path not exist
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
getPathByNodeId
public ArrayList<String> getPathByNodeId(com.plccom.opc.ua.builtintypes.ExpandedNodeId expandednodeId) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Returns aArrayListof logical paths from providedNodeId- Parameters:
expandednodeId- the providedExpandedNodeId- Returns:
ArrayListof String objects, null when nodeId not exist- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
getPathByNodeId
public ArrayList<String> getPathByNodeId(com.plccom.opc.ua.builtintypes.NodeId nodeid) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Returns aArrayListof logical paths from providedNodeId- Parameters:
nodeid- the providedExpandedNodeId- Returns:
ArrayListof String objects, null when nodeId not exist- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
getSeparator
public char getSeparator()
return current path separator (usually '.')- Returns:
- return current path separator (usually '.')
-
setSeparator
public void setSeparator(char value)
set the path separator (usually '.')- Parameters:
value- new path separator
-
findEventElement
public static com.plccom.opc.ua.builtintypes.NodeId findEventElement(MonitoredItem monitoredItem, com.plccom.opc.ua.core.EventFieldList notification, BrowseNames browseName)
Finds the type of the event for the notification.- Parameters:
monitoredItem- The monitored item.notification- The notification.browseName- The browse name of element to be find.- Returns:
- The mNodeId of the EventType.
-
findConditionInstanceNode
public static com.plccom.opc.ua.builtintypes.NodeId findConditionInstanceNode(MonitoredItem monitoredItem, com.plccom.opc.ua.core.EventFieldList notification)
Finds the type of the event for the notification.- Parameters:
monitoredItem- The monitored item.notification- The notification.- Returns:
- The mNodeId of the EventType.
-
refreshConditions
public void refreshConditions(UaSubscription subscription) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Triggers a condition refresh on the specified subscription, causing the server to resend the current state of all active conditions. This is useful after establishing a new event subscription to get the initial state of all active alarms and conditions.- Parameters:
subscription- theUaSubscriptionwhose conditions should be refreshed. Ifnullor has no monitored items, the call is ignored.- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
findEventType
public static com.plccom.opc.ua.builtintypes.NodeId findEventType(MonitoredItem monitoredItem, com.plccom.opc.ua.core.EventFieldList notification)
Finds the EventType NodeId from an event notification by searching the select clauses of the monitored item's event filter for the "EventType" field.- Parameters:
monitoredItem- the monitored item that produced the notificationnotification- the event notification- Returns:
- the
NodeIdof the event type, ornullif not found
-
getNodeCache
public UaNodeCache getNodeCache()
Returns the internal node cache- Returns:
- the internal node cache
-
getUaAddressSpace
public UaAddressSpace getUaAddressSpace()
Returns the internal Ua adress space- Returns:
- the internal Ua adress space
-
getUaNode
public UaNode getUaNode(com.plccom.opc.ua.builtintypes.NodeId nodeid) throws com.plccom.opc.ua.common.ServiceResultException
Returns a class derived from UaNode with extended fields and informations about the NodeId- Parameters:
nodeid- the based NodeId- Returns:
- a class derived from UaNode with extended fields and informations about the NodeId
- Throws:
com.plccom.opc.ua.common.ServiceResultException- on communication error
-
getUaNode
public UaNode getUaNode(com.plccom.opc.ua.core.ReferenceDescription referenceDescription) throws com.plccom.opc.ua.common.ServiceResultException
Returns a class derived from UaNode with extended fields and informations about the ReferenceDescription- Parameters:
referenceDescription- the based ReferenceDescription- Returns:
- a class derived from UaNode with extended fields and informations about the ReferenceDescription
- Throws:
com.plccom.opc.ua.common.ServiceResultException- on communication error
-
getUaNode
public UaNode getUaNode(com.plccom.opc.ua.builtintypes.ExpandedNodeId expandedNodeId) throws com.plccom.opc.ua.common.ServiceResultException
Returns a class derived from UaNode with extended fields and informations about the expandedNodeId- Parameters:
expandedNodeId- the based expandedNodeId- Returns:
- a class derived from UaNode with extended fields and informations about the expandedNodeId
- Throws:
com.plccom.opc.ua.common.ServiceResultException- on communication error
-
getUaNode
public UaNode getUaNode(com.plccom.opc.ua.builtintypes.NodeId nodeid, com.plccom.opc.ua.builtintypes.NodeId nodetype) throws com.plccom.opc.ua.common.ServiceResultException
Returns a class derived from UaNode with extended fields and informations about the NodeId- Parameters:
nodeid- the based NodeIdnodetype- the NodeId represents the node type- Returns:
- a class derived from UaNode with extended fields and informations about the NodeId
- Throws:
com.plccom.opc.ua.common.ServiceResultException- on communication error
-
getUaNode
public UaNode getUaNode(com.plccom.opc.ua.core.ReferenceDescription referenceDescription, com.plccom.opc.ua.builtintypes.NodeId nodetype) throws com.plccom.opc.ua.common.ServiceResultException
Returns a class derived from UaNode with extended fields and informations about the ReferenceDescription- Parameters:
referenceDescription- the based ReferenceDescriptionnodetype- the NodeId represents the node type- Returns:
- a class derived from UaNode with extended fields and informations about the ReferenceDescription
- Throws:
com.plccom.opc.ua.common.ServiceResultException- on communication error
-
getUaNode
public UaNode getUaNode(com.plccom.opc.ua.builtintypes.ExpandedNodeId expandedNodeId, com.plccom.opc.ua.builtintypes.NodeId nodetype) throws com.plccom.opc.ua.common.ServiceResultException
Returns a class derived from UaNode with extended fields and informations about the expandedNodeId- Parameters:
expandedNodeId- the based expandedNodeIdnodetype- the NodeId represents the node type- Returns:
- a class derived from UaNode with extended fields and informations about the expandedNodeId
- Throws:
com.plccom.opc.ua.common.ServiceResultException- on communication error
-
getSessionConfiguration
public ClientConfiguration getSessionConfiguration()
Returns the current SessionConfiguration- Returns:
- the current ClientConfiguration object
-
getNamespaceUris
public com.plccom.opc.ua.common.NamespaceTable getNamespaceUris()
Returns the namespace table known to the current session. The namespace table maps namespace indices to namespace URIs.- Returns:
- the
NamespaceTableof the current session, ornullif no session is established
-
getServerUris
public com.plccom.opc.ua.common.ServerTable getServerUris()
Returns the server URI table known to the current session. The server table maps server indices to server URIs.- Returns:
- the server URI table, or
nullif no session is established
-
getSessionTimeout
public double getSessionTimeout()
Returns the negotiated session timeout in milliseconds. This is the period the server will maintain the session without client communication.- Returns:
- the session timeout in milliseconds, or
0if no session is established
-
isTolerateFaultyServerState
public boolean isTolerateFaultyServerState()
Returns whether the client tolerates a server that reports a state other than "Running".- Returns:
trueif faulty server states are tolerated- See Also:
setTolerateFaultyServerState(boolean)
-
setTolerateFaultyServerState
public void setTolerateFaultyServerState(boolean value)
Sets whether the client tolerates a server that reports a state other than "Running".A server can be reachable and still report that it is not working, for example "Suspended" or "Failed". By default (
false) the client treats that as a lost connection:isConnected()turnsfalseand the connection listeners are told. The session itself is kept, not rebuilt, and its subscriptions stay in place; data the server sends for them in the meantime is still delivered. As soon as the server reports "Running" again the client counts as connected again. Withtruethe client stays connected whatever state the server reports.The state "Unknown" never counts as a loss. The setting takes effect on a running session with the next keep-alive.
Warning: Server data may be incorrect while the server is not "Running". Use
trueat your own risk.- Parameters:
value-trueto tolerate faulty server states
-
modifySessionConfiguration
public void modifySessionConfiguration(ClientConfiguration clientConfiguration, boolean reconnect) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Replaces the current session configuration and optionally reconnects to the server. The existing session is closed before applying the new configuration.- Parameters:
clientConfiguration- the newClientConfigurationto applyreconnect- iftrue, a new connection is established immediately after applying the configuration- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
endpointToString
@Deprecated public static String endpointToString(com.plccom.opc.ua.core.EndpointDescription endpoint)
Deprecated.Returns a human-readable string representation of the specifiedEndpointDescription, including URL, security mode, and security policy.- Parameters:
endpoint- theEndpointDescriptionto format- Returns:
- a descriptive string representation of the endpoint
-
subscriptionToString
@Deprecated public static String subscriptionToString(UaSubscription subscription)
Deprecated.UseOpcUaDisplayUtils.toDisplayString(UaSubscription)instead.Returns a human-readable string representation of the specifiedUaSubscription, including subscription ID and monitored item count.- Parameters:
subscription- theUaSubscriptionto format- Returns:
- a descriptive string representation of the subscription
-
getSessionChannel
public UaSessionChannel getSessionChannel()
Returns actual SessionChannel- Returns:
- the current
UaSessionChannelobject
-
discoverEndpoints
public static com.plccom.opc.ua.core.EndpointDescription[] discoverEndpoints(URI discoveryEndpointUri) throws com.plccom.opc.ua.common.ServiceResultException
Gets endpoints on the opc ua server, filtered to match the transport protocol of the discovery URL. For example, if the discovery URL usesopc.tcp, onlyopc.tcpendpoints are returned -opc.httpsendpoints are excluded. This mirrors the behaviour of the C# SDK'sGetEndpoints(Uri)method.Use
discoverAllEndpoints(URI)if you need all endpoints regardless of transport protocol.- Parameters:
discoveryEndpointUri- the discovery URI (e.g.opc.tcp://localhost:48410)- Returns:
- an array of
EndpointDescriptionobjects matching the transport protocol of the discovery URL - Throws:
com.plccom.opc.ua.common.ServiceResultException- occurs by internal error, please analyze the exception object
-
discoverEndpoints
public static com.plccom.opc.ua.core.EndpointDescription[] discoverEndpoints(URI discoveryEndpointUri, com.plccom.opc.ua.transport.security.CertificateValidator certificateValidator) throws com.plccom.opc.ua.common.ServiceResultException
Gets endpoints on the opc ua server, filtered to match the transport protocol of the discovery URL. Foropc.httpsURLs aCertificateValidatormust be provided to validate the server's TLS certificate.- Parameters:
discoveryEndpointUri- the discovery URIcertificateValidator- validator for the server TLS certificate, required foropc.https- Returns:
- an array of
EndpointDescriptionobjects matching the transport protocol of the discovery URL - Throws:
com.plccom.opc.ua.common.ServiceResultException- occurs by internal error, please analyze the exception object
-
discoverAllEndpoints
public static com.plccom.opc.ua.core.EndpointDescription[] discoverAllEndpoints(URI discoveryEndpointUri) throws com.plccom.opc.ua.common.ServiceResultException
Gets all endpoints on the opc ua server, regardless of transport protocol. Returns bothopc.tcpandopc.httpsendpoints (and any other transports the server offers). This mirrors the behaviour of the C# SDK'sGetAllEndpoints(Uri)method.Use
discoverEndpoints(URI)if you only want endpoints matching the transport protocol of the discovery URL.- Parameters:
discoveryEndpointUri- the discovery URI- Returns:
- an array of all
EndpointDescriptionobjects offered by the server - Throws:
com.plccom.opc.ua.common.ServiceResultException- occurs by internal error, please analyze the exception object
-
discoverAllEndpoints
public static com.plccom.opc.ua.core.EndpointDescription[] discoverAllEndpoints(URI discoveryEndpointUri, com.plccom.opc.ua.transport.security.CertificateValidator certificateValidator) throws com.plccom.opc.ua.common.ServiceResultException
Gets all endpoints on the opc ua server, regardless of transport protocol. Foropc.httpsURLs aCertificateValidatormust be provided to validate the server's TLS certificate.- Parameters:
discoveryEndpointUri- the discovery URIcertificateValidator- validator for the server TLS certificate, required foropc.https- Returns:
- an array of all
EndpointDescriptionobjects offered by the server - Throws:
com.plccom.opc.ua.common.ServiceResultException- occurs by internal error, please analyze the exception object
-
discoverEndpoints
public static com.plccom.opc.ua.core.EndpointDescription[] discoverEndpoints(String hostName, int port) throws com.plccom.opc.ua.common.ServiceResultException
Gets endpoints on the opc ua server- Parameters:
hostName- Name or ip of the host please use port 4048port- the port number of the OPC UA server- Returns:
- a array of strings with the actual endpoints of server
- Throws:
com.plccom.opc.ua.common.ServiceResultException- occurs by internal error, please analyze the exception object
-
discoverEndpoints
public static com.plccom.opc.ua.core.EndpointDescription[] discoverEndpoints(String hostName, int port, String instanceName) throws com.plccom.opc.ua.common.ServiceResultException
Gets endpoints on the opc ua server- Parameters:
hostName- Name or ip of the hostport- number of port, if server registered by discovery server please use port 4048instanceName- optional name of instance- Returns:
- a array of strings with the actual endpoints of server
- Throws:
com.plccom.opc.ua.common.ServiceResultException- occurs by internal error, please analyze the exception object
-
findBestEndpoint
public static com.plccom.opc.ua.core.EndpointDescription findBestEndpoint(URI discoveryUrl, com.plccom.opc.ua.core.MessageSecurityMode messageSecurityMode) throws com.plccom.opc.ua.common.ServiceResultException, URISyntaxException
select a custom endpoint by discoveryUrl, with or without security mode- Parameters:
discoveryUrl- the discovery urlmessageSecurityMode- select the endpoint with or without security- Returns:
- EndpointDescription object
- Throws:
com.plccom.opc.ua.common.ServiceResultException- by internal errorURISyntaxException- thrown to indicate that a string could not be parsed as a URI reference.
-
findBestEndpoint
public static com.plccom.opc.ua.core.EndpointDescription findBestEndpoint(URI discoveryUrl, URI knownEndpointUrl, com.plccom.opc.ua.core.MessageSecurityMode messageSecurityMode) throws com.plccom.opc.ua.common.ServiceResultException, URISyntaxException
get endpoint by discoveryUrl, and find the best endpoint by known endpoint url- Parameters:
discoveryUrl- the discovery urlknownEndpointUrl- a known endpoint urlmessageSecurityMode- select the endpoint with or without security- Returns:
- EndpointDescription object
- Throws:
com.plccom.opc.ua.common.ServiceResultException- by internal errorURISyntaxException- thrown to indicate that a string could not be parsed as a URI reference.
-
findBestEndpoint
public static com.plccom.opc.ua.core.EndpointDescription findBestEndpoint(URI discoveryUrl, EndpointProtocol endpointProtocol, com.plccom.opc.ua.core.MessageSecurityMode messageSecurityMode) throws com.plccom.opc.ua.common.ServiceResultException, URISyntaxException
get endpoint by discoveryUrl, and find the best endpoint by endpoint protocol and message security mode- Parameters:
discoveryUrl- the discovery urlendpointProtocol- the endpoint protocolmessageSecurityMode- select the endpoint with or without security- Returns:
- EndpointDescription object
- Throws:
com.plccom.opc.ua.common.ServiceResultException- by internal errorURISyntaxException- thrown to indicate that a string could not be parsed as a URI reference.
-
sortBySecurityLevel
public static com.plccom.opc.ua.core.EndpointDescription[] sortBySecurityLevel(com.plccom.opc.ua.core.EndpointDescription[] endpoints, SortDirection sortDirection)Sorts endpoints by their security level. The highest security level last.- Parameters:
endpoints- set of endpointssortDirection- the sort direction asc or desc- Returns:
- sorted array of endpoints
-
filterEndpoints
public static com.plccom.opc.ua.core.EndpointDescription[] filterEndpoints(com.plccom.opc.ua.core.EndpointDescription[] endpoints, EndpointProtocol endpointProtocol, SortDirection sortDirection)Filter all EndpointDescriptions by protocol- Parameters:
endpoints- EndpointDescriptions for filteringendpointProtocol- The desired endpoint protocolsortDirection- enum SortDirection, sort result asc or desc by security level- Returns:
- a sorted array of EndpointDescription objects
-
filterEndpoints
public static com.plccom.opc.ua.core.EndpointDescription[] filterEndpoints(com.plccom.opc.ua.core.EndpointDescription[] endpoints, EndpointProtocol endpointProtocol, com.plccom.opc.ua.core.MessageSecurityMode messageSecurityMode, SortDirection sortDirection)Filter all EndpointDescriptions by protocol- Parameters:
endpoints- EndpointDescriptions for filteringendpointProtocol- Filter out all by SecurityModemessageSecurityMode- the desired MessageSecurityModesortDirection- enum SortDirection, sort result asc or desc by security level- Returns:
- a sorted array of EndpointDescription objects
-
filterEndpoints
public static com.plccom.opc.ua.core.EndpointDescription[] filterEndpoints(com.plccom.opc.ua.core.EndpointDescription[] endpoints, EndpointProtocol endpointProtocol, com.plccom.opc.ua.core.MessageSecurityMode messageSecurityMode, com.plccom.opc.ua.transport.security.SecurityPolicy securityPolicy, SortDirection sortDirection)Filter all EndpointDescriptions by protocol- Parameters:
endpoints- EndpointDescriptions for filteringendpointProtocol- Filter out all by SecurityModemessageSecurityMode- Filter out all by MessageSecurityModesecurityPolicy- Filter out all by SecurityPolicysortDirection- sortDirection enum SortDirection, sort result asc or desc by security level- Returns:
- a sorted array of EndpointDescription objects
-
findServer
public static com.plccom.opc.ua.core.ApplicationDescription[] findServer(String discoverServerEndpointUrl) throws com.plccom.opc.ua.common.ServiceResultException
Discover applications- Parameters:
discoverServerEndpointUrl- endpointURI that is also the socket address- Returns:
- Endpoint Application Descriptions
- Throws:
com.plccom.opc.ua.common.ServiceResultException- by internal error
-
findServer
public static com.plccom.opc.ua.core.ApplicationDescription[] findServer(String connectUrl, String discoverServerEndpointUri) throws com.plccom.opc.ua.common.ServiceResultException
Discover applications- Parameters:
connectUrl- address that contains the socket address to the endpointdiscoverServerEndpointUri- endpointURI or ""- Returns:
- Endpoint Application Descriptions
- Throws:
com.plccom.opc.ua.common.ServiceResultException- occurs by internal error, please analyze the exception object
-
findServerAsync
public static void findServerAsync(String connectUrl, String discoverServerEndpointUri, FindServerListener callback) throws com.plccom.opc.ua.common.ServiceResultException
Discover applications- Parameters:
connectUrl- address that contains the socket address to the endpointdiscoverServerEndpointUri- endpointURI or empty stringcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceResultException- occurs by internal error, please analyze the exception object
-
browseSuperTypes
public static ReferenceDescriptionCollection browseSuperTypes(com.plccom.opc.ua.application.SessionChannel sessionChannel, com.plccom.opc.ua.builtintypes.NodeId typeId, boolean throwOnError) throws com.plccom.opc.ua.common.ServiceResultException
Browses the address space and returns all of the supertypes of the specified type node.- Parameters:
sessionChannel- connected opc ua sessionchanneltypeId- The mNodeId for a type node in the address space.throwOnError- if set to true a exception will be thrown on an error.- Returns:
- The references found. Null if an error occurred.
- Throws:
com.plccom.opc.ua.common.ServiceResultException- occurs by internal error, please analyze the exception object
-
queryFirst
public com.plccom.opc.ua.core.QueryFirstResponse queryFirst(com.plccom.opc.ua.core.ViewDescription view, com.plccom.opc.ua.core.NodeTypeDescription[] nodeTypes, com.plccom.opc.ua.core.ContentFilter filter, com.plccom.opc.ua.builtintypes.UnsignedInteger maxDataSetsToReturn, com.plccom.opc.ua.builtintypes.UnsignedInteger maxReferencesToReturn) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous QueryFirst service request. Executes a query against the server address space to find nodes matching the specified criteria.- Parameters:
view- the view to query, may be null for the default viewnodeTypes- the node type descriptions that define the query filter criteriafilter- the content filter used to restrict the result setmaxDataSetsToReturn- the maximum number of data sets to return; use 0 for no limitmaxReferencesToReturn- the maximum number of references to return; use 0 for no limit- Returns:
- a QueryFirstResponse containing the matching data sets and a continuation point
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
queryFirst
public com.plccom.opc.ua.core.QueryFirstResponse queryFirst(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.ViewDescription view, com.plccom.opc.ua.core.NodeTypeDescription[] nodeTypes, com.plccom.opc.ua.core.ContentFilter filter, com.plccom.opc.ua.builtintypes.UnsignedInteger maxDataSetsToReturn, com.plccom.opc.ua.builtintypes.UnsignedInteger maxReferencesToReturn) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous QueryFirst service request.- Parameters:
requestHeader- a RequestHeader object, may be nullview- the view to query, may be null for the default viewnodeTypes- the node type descriptions that define the query filter criteriafilter- the content filter used to restrict the result setmaxDataSetsToReturn- the maximum number of data sets to return; use 0 for no limitmaxReferencesToReturn- the maximum number of references to return; use 0 for no limit- Returns:
- a QueryFirstResponse containing the matching data sets and a continuation point
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
queryFirst
public com.plccom.opc.ua.core.QueryFirstResponse queryFirst(com.plccom.opc.ua.core.QueryFirstRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous QueryFirst service request.- Parameters:
req- the QueryFirstRequest- Returns:
- a QueryFirstResponse containing the matching data sets and a continuation point
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
queryFirstAsync
public void queryFirstAsync(com.plccom.opc.ua.core.ViewDescription view, com.plccom.opc.ua.core.NodeTypeDescription[] nodeTypes, com.plccom.opc.ua.core.ContentFilter filter, com.plccom.opc.ua.builtintypes.UnsignedInteger maxDataSetsToReturn, com.plccom.opc.ua.builtintypes.UnsignedInteger maxReferencesToReturn, QueryFirstListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous QueryFirst service request.- Parameters:
view- the view to query, may be null for the default viewnodeTypes- the node type descriptions that define the query filter criteriafilter- the content filter used to restrict the result setmaxDataSetsToReturn- the maximum number of data sets to return; use 0 for no limitmaxReferencesToReturn- the maximum number of references to return; use 0 for no limitcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
queryFirstAsync
public void queryFirstAsync(com.plccom.opc.ua.core.QueryFirstRequest req, QueryFirstListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous QueryFirst service request.- Parameters:
req- the QueryFirstRequestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
queryNext
public com.plccom.opc.ua.core.QueryNextResponse queryNext(Boolean releaseContinuationPoint, com.plccom.opc.ua.builtintypes.ByteString continuationPoint) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Synchronous QueryNext service request. Continues a query operation that was previously started with queryFirst. Use this method to retrieve additional results when the initial query returned a continuation point.- Parameters:
releaseContinuationPoint- iftrue, the continuation point is released without returning further resultscontinuationPoint- the continuation point returned from a previous QueryFirst or QueryNext call- Returns:
- a QueryNextResponse containing the next set of query results
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
queryNext
public com.plccom.opc.ua.core.QueryNextResponse queryNext(com.plccom.opc.ua.core.RequestHeader requestHeader, Boolean releaseContinuationPoint, com.plccom.opc.ua.builtintypes.ByteString continuationPoint) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous QueryNext service request.- Parameters:
requestHeader- a RequestHeader object, may be nullreleaseContinuationPoint- iftrue, the continuation point is released without returning further resultscontinuationPoint- the continuation point returned from a previous QueryFirst or QueryNext call- Returns:
- a QueryNextResponse containing the next set of query results
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
queryNext
public com.plccom.opc.ua.core.QueryNextResponse queryNext(com.plccom.opc.ua.core.QueryNextRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous QueryNext service request.- Parameters:
req- the QueryNextRequest- Returns:
- a QueryNextResponse containing the next set of query results
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
queryNextAsync
public void queryNextAsync(Boolean releaseContinuationPoint, com.plccom.opc.ua.builtintypes.ByteString continuationPoint, QueryNextListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Asynchronous QueryNext service request.- Parameters:
releaseContinuationPoint- iftrue, the continuation point is released without returning further resultscontinuationPoint- the continuation point returned from a previous QueryFirst or QueryNext callcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
queryNextAsync
public void queryNextAsync(com.plccom.opc.ua.core.QueryNextRequest req, QueryNextListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous QueryNext service request.- Parameters:
req- the QueryNextRequestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
cancel
public com.plccom.opc.ua.core.CancelResponse cancel(com.plccom.opc.ua.builtintypes.UnsignedInteger requestHandle) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Cancel service request. Cancels one or more outstanding service requests on the server.- Parameters:
requestHandle- the handle assigned to the request(s) to cancel- Returns:
- a CancelResponse containing the number of cancelled requests
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
cancel
public com.plccom.opc.ua.core.CancelResponse cancel(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger requestHandle) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Cancel service request.- Parameters:
requestHeader- a RequestHeader object, may be nullrequestHandle- the handle assigned to the request(s) to cancel- Returns:
- a CancelResponse containing the number of cancelled requests
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
cancel
public com.plccom.opc.ua.core.CancelResponse cancel(com.plccom.opc.ua.core.CancelRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Cancel service request.- Parameters:
req- the CancelRequest- Returns:
- a CancelResponse containing the number of cancelled requests
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
cancelAsync
public void cancelAsync(com.plccom.opc.ua.builtintypes.UnsignedInteger requestHandle, CancelListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Cancel service request.- Parameters:
requestHandle- the handle assigned to the request(s) to cancelcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
cancelAsync
public void cancelAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger requestHandle, CancelListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Cancel service request.- Parameters:
requestHeader- a RequestHeader object, may be nullrequestHandle- the handle assigned to the request(s) to cancelcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
cancelAsync
public void cancelAsync(com.plccom.opc.ua.core.CancelRequest req, CancelListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Cancel service request.- Parameters:
req- the CancelRequestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
transferSubscriptions
public com.plccom.opc.ua.core.TransferSubscriptionsResponse transferSubscriptions(com.plccom.opc.ua.builtintypes.UnsignedInteger[] subscriptionIds, Boolean sendInitialValues) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous TransferSubscriptions service request. Transfers one or more subscriptions from another session to the current session.- Parameters:
subscriptionIds- the identifiers of the subscriptions to transfersendInitialValues- iftrue, the server sends the current values for all monitored items after the transfer- Returns:
- a TransferSubscriptionsResponse containing the transfer result for each subscription
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
transferSubscriptions
public com.plccom.opc.ua.core.TransferSubscriptionsResponse transferSubscriptions(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger[] subscriptionIds, Boolean sendInitialValues) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous TransferSubscriptions service request.- Parameters:
requestHeader- a RequestHeader object, may be nullsubscriptionIds- the identifiers of the subscriptions to transfersendInitialValues- iftrue, the server sends the current values for all monitored items after the transfer- Returns:
- a TransferSubscriptionsResponse containing the transfer result for each subscription
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
transferSubscriptions
public com.plccom.opc.ua.core.TransferSubscriptionsResponse transferSubscriptions(com.plccom.opc.ua.core.TransferSubscriptionsRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous TransferSubscriptions service request.- Parameters:
req- the TransferSubscriptionsRequest- Returns:
- a TransferSubscriptionsResponse containing the transfer result for each subscription
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
transferSubscriptionsAsync
public void transferSubscriptionsAsync(com.plccom.opc.ua.builtintypes.UnsignedInteger[] subscriptionIds, Boolean sendInitialValues, TransferSubscriptionsListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous TransferSubscriptions service request.- Parameters:
subscriptionIds- the identifiers of the subscriptions to transfersendInitialValues- iftrue, the server sends the current values for all monitored items after the transfercallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
transferSubscriptionsAsync
public void transferSubscriptionsAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger[] subscriptionIds, Boolean sendInitialValues, TransferSubscriptionsListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous TransferSubscriptions service request.- Parameters:
requestHeader- a RequestHeader object, may be nullsubscriptionIds- the identifiers of the subscriptions to transfersendInitialValues- iftrue, the server sends the current values for all monitored items after the transfercallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
transferSubscriptionsAsync
public void transferSubscriptionsAsync(com.plccom.opc.ua.core.TransferSubscriptionsRequest req, TransferSubscriptionsListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous TransferSubscriptions service request.- Parameters:
req- the TransferSubscriptionsRequestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
setTriggering
public com.plccom.opc.ua.core.SetTriggeringResponse setTriggering(com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger triggeringItemId, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToAdd, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToRemove) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous SetTriggering service request. Configures triggering links between monitored items within a subscription. A triggering item can cause linked items to report or sample when it triggers.- Parameters:
subscriptionId- the unique identifier of the subscriptiontriggeringItemId- the server-assigned identifier of the triggering monitored itemlinksToAdd- identifiers of monitored items to link as triggered itemslinksToRemove- identifiers of monitored items to unlink from the triggering item- Returns:
- a SetTriggeringResponse containing the status codes for each link addition and removal
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
setTriggering
public com.plccom.opc.ua.core.SetTriggeringResponse setTriggering(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger triggeringItemId, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToAdd, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToRemove) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous SetTriggering service request.- Parameters:
requestHeader- a RequestHeader object, may be nullsubscriptionId- the unique identifier of the subscriptiontriggeringItemId- the server-assigned identifier of the triggering monitored itemlinksToAdd- identifiers of monitored items to link as triggered itemslinksToRemove- identifiers of monitored items to unlink from the triggering item- Returns:
- a SetTriggeringResponse containing the status codes for each link addition and removal
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
setTriggering
public com.plccom.opc.ua.core.SetTriggeringResponse setTriggering(com.plccom.opc.ua.core.SetTriggeringRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous SetTriggering service request.- Parameters:
req- the SetTriggeringRequest- Returns:
- a SetTriggeringResponse containing the status codes for each link addition and removal
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
setTriggeringAsync
public void setTriggeringAsync(com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger triggeringItemId, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToAdd, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToRemove, SetTriggeringListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous SetTriggering service request.- Parameters:
subscriptionId- the unique identifier of the subscriptiontriggeringItemId- the server-assigned identifier of the triggering monitored itemlinksToAdd- identifiers of monitored items to link as triggered itemslinksToRemove- identifiers of monitored items to unlink from the triggering itemcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
setTriggeringAsync
public void setTriggeringAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger triggeringItemId, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToAdd, com.plccom.opc.ua.builtintypes.UnsignedInteger[] linksToRemove, SetTriggeringListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous SetTriggering service request.- Parameters:
requestHeader- a RequestHeader object, may be nullsubscriptionId- the unique identifier of the subscriptiontriggeringItemId- the server-assigned identifier of the triggering monitored itemlinksToAdd- identifiers of monitored items to link as triggered itemslinksToRemove- identifiers of monitored items to unlink from the triggering itemcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
setTriggeringAsync
public void setTriggeringAsync(com.plccom.opc.ua.core.SetTriggeringRequest req, SetTriggeringListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous SetTriggering service request.- Parameters:
req- the SetTriggeringRequestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addNodes
public com.plccom.opc.ua.core.AddNodesResponse addNodes(com.plccom.opc.ua.core.AddNodesItem... nodesToAdd) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous AddNodes service request. Adds one or more nodes to the server address space.- Parameters:
nodesToAdd- one or more node definitions to add- Returns:
- an AddNodesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addNodes
public com.plccom.opc.ua.core.AddNodesResponse addNodes(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.AddNodesItem... nodesToAdd) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous AddNodes service request.- Parameters:
requestHeader- a RequestHeader object, may be nullnodesToAdd- one or more node definitions to add- Returns:
- an AddNodesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addNodes
public com.plccom.opc.ua.core.AddNodesResponse addNodes(com.plccom.opc.ua.core.AddNodesRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous AddNodes service request.- Parameters:
req- the request- Returns:
- an AddNodesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addNodesAsync
public void addNodesAsync(com.plccom.opc.ua.core.AddNodesItem[] nodesToAdd, AddNodesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous AddNodes service request.- Parameters:
nodesToAdd- one or more node definitions to addcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addNodesAsync
public void addNodesAsync(com.plccom.opc.ua.core.AddNodesRequest req, AddNodesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous AddNodes service request.- Parameters:
req- the requestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addReferences
public com.plccom.opc.ua.core.AddReferencesResponse addReferences(com.plccom.opc.ua.core.AddReferencesItem... referencesToAdd) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous AddReferences service request. Adds one or more references between nodes in the server address space.- Parameters:
referencesToAdd- one or more reference definitions to add- Returns:
- an AddReferencesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addReferences
public com.plccom.opc.ua.core.AddReferencesResponse addReferences(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.AddReferencesItem... referencesToAdd) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous AddReferences service request.- Parameters:
requestHeader- a RequestHeader object, may be nullreferencesToAdd- one or more reference definitions to add- Returns:
- an AddReferencesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addReferences
public com.plccom.opc.ua.core.AddReferencesResponse addReferences(com.plccom.opc.ua.core.AddReferencesRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous AddReferences service request.- Parameters:
req- the request- Returns:
- an AddReferencesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addReferencesAsync
public void addReferencesAsync(com.plccom.opc.ua.core.AddReferencesItem[] referencesToAdd, AddReferencesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous AddReferences service request.- Parameters:
referencesToAdd- one or more reference definitions to addcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addReferencesAsync
public void addReferencesAsync(com.plccom.opc.ua.core.AddReferencesRequest req, AddReferencesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous AddReferences service request.- Parameters:
req- the requestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteNodes
public com.plccom.opc.ua.core.DeleteNodesResponse deleteNodes(com.plccom.opc.ua.core.DeleteNodesItem... nodesToDelete) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous DeleteNodes service request. Deletes one or more nodes from the server address space.- Parameters:
nodesToDelete- one or more node definitions to delete- Returns:
- a DeleteNodesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteNodes
public com.plccom.opc.ua.core.DeleteNodesResponse deleteNodes(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.DeleteNodesItem... nodesToDelete) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous DeleteNodes service request.- Parameters:
requestHeader- a RequestHeader object, may be nullnodesToDelete- one or more node definitions to delete- Returns:
- a DeleteNodesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteNodes
public com.plccom.opc.ua.core.DeleteNodesResponse deleteNodes(com.plccom.opc.ua.core.DeleteNodesRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous DeleteNodes service request.- Parameters:
req- the request- Returns:
- a DeleteNodesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteNodesAsync
public void deleteNodesAsync(com.plccom.opc.ua.core.DeleteNodesItem[] nodesToDelete, DeleteNodesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous DeleteNodes service request.- Parameters:
nodesToDelete- one or more node definitions to deletecallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteNodesAsync
public void deleteNodesAsync(com.plccom.opc.ua.core.DeleteNodesRequest req, DeleteNodesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous DeleteNodes service request.- Parameters:
req- the requestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteReferences
public com.plccom.opc.ua.core.DeleteReferencesResponse deleteReferences(com.plccom.opc.ua.core.DeleteReferencesItem... referencesToDelete) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous DeleteReferences service request. Deletes one or more references between nodes in the server address space.- Parameters:
referencesToDelete- one or more reference definitions to delete- Returns:
- a DeleteReferencesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteReferences
public com.plccom.opc.ua.core.DeleteReferencesResponse deleteReferences(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.DeleteReferencesItem... referencesToDelete) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous DeleteReferences service request.- Parameters:
requestHeader- a RequestHeader object, may be nullreferencesToDelete- one or more reference definitions to delete- Returns:
- a DeleteReferencesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteReferences
public com.plccom.opc.ua.core.DeleteReferencesResponse deleteReferences(com.plccom.opc.ua.core.DeleteReferencesRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous DeleteReferences service request.- Parameters:
req- the request- Returns:
- a DeleteReferencesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteReferencesAsync
public void deleteReferencesAsync(com.plccom.opc.ua.core.DeleteReferencesItem[] referencesToDelete, DeleteReferencesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous DeleteReferences service request.- Parameters:
referencesToDelete- one or more reference definitions to deletecallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteReferencesAsync
public void deleteReferencesAsync(com.plccom.opc.ua.core.DeleteReferencesRequest req, DeleteReferencesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous DeleteReferences service request.- Parameters:
req- the requestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browse
public com.plccom.opc.ua.core.BrowseResponse browse(com.plccom.opc.ua.core.BrowseDescription... nodesToBrowse) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Browse service request. This service is used to discover the references of a specified node.- Parameters:
nodesToBrowse- one or more browse descriptions with browse informations- Returns:
- the BrowseResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browse
public com.plccom.opc.ua.core.BrowseResponse browse(com.plccom.opc.ua.core.BrowseRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Browse service request. This service is used to discover the references of a specified node.- Parameters:
req- the request- Returns:
- the BrowseResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browseFull
public com.plccom.opc.ua.core.BrowseResponse browseFull(com.plccom.opc.ua.core.BrowseDescription... nodesToBrowse) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous full Browse service request inclusive all necessary browseNext executions. This service is used to discover the references of a specified node.- Parameters:
nodesToBrowse- one or more browse descriptions with browse informations- Returns:
- the BrowseResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browseFull
public com.plccom.opc.ua.core.BrowseResponse browseFull(com.plccom.opc.ua.core.BrowseRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous full Browse service request inclusive all necessary browseNext executions. This service is used to discover the references of a specified node.- Parameters:
req- the request- Returns:
- the BrowseResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browseAsync
public void browseAsync(com.plccom.opc.ua.core.BrowseDescription nodesToBrowse, BrowseListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Browse service request. This service is used to discover the references of a specified node.- Parameters:
nodesToBrowse- the BrowseDescription requestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browseAsync
public void browseAsync(com.plccom.opc.ua.core.BrowseDescription[] nodesToBrowse, BrowseListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Browse service request. This service is used to discover the references of a specified node.- Parameters:
nodesToBrowse- a array of BrowseDescription objectscallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browseAsync
public void browseAsync(com.plccom.opc.ua.core.BrowseRequest req, BrowseListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Browse service request. This service is used to discover the references of a specified node.- Parameters:
req- the BrowseRequestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browseNext
public com.plccom.opc.ua.core.BrowseNextResponse browseNext(Boolean releaseContinuationPoints, com.plccom.opc.ua.builtintypes.ByteString... continuationPoints) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.�Too large� in this context means that the server is not able to return a larger response or that the number of results to return exceeds the maximum number of results to return that was specified by the client in the original Browse request.
- Parameters:
releaseContinuationPoints- if true, passed continuationPoints shall be reset to free resources in the server. If false, passed continuationPoints shall be used to get the next set of browse information.continuationPoints- a list of server-defined opaque values that represent continuation points.- Returns:
- a BrowseNextResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browseNext
public com.plccom.opc.ua.core.BrowseNextResponse browseNext(com.plccom.opc.ua.core.BrowseNextRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThis service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response. �Too large� in this context means that the server is not able to return a larger response or that the number of results to return exceeds the maximum number of results to return that was specified by the client in the original Browse request.- Parameters:
req- the BrowseNextRequest- Returns:
- a BrowseNextResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browseNextAsync
public void browseNextAsync(Boolean releaseContinuationPoints, com.plccom.opc.ua.builtintypes.ByteString continuationPoints, BrowseListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.�Too large� in this context means that the server is not able to return a larger response or that the number of results to return exceeds the maximum number of results to return that was specified by the client in the original Browse request.
- Parameters:
releaseContinuationPoints- if true, passed continuationPoints shall be reset to free resources in the server. If false, passed continuationPoints shall be used to get the next set of browse information.continuationPoints- a array of server-defined values that represent the continuation pointcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browseNextAsync
public void browseNextAsync(Boolean releaseContinuationPoints, com.plccom.opc.ua.builtintypes.ByteString[] continuationPoints, BrowseListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.�Too large� in this context means that the server is not able to return a larger response or that the number of results to return exceeds the maximum number of results to return that was specified by the client in the original Browse request.
- Parameters:
releaseContinuationPoints- if true, passed continuationPoints shall be reset to free resources in the server. If false, passed continuationPoints shall be used to get the next set of browse information.continuationPoints- a array of server-defined values that represent the continuation points.callback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
browseNextAsync
public void browseNextAsync(com.plccom.opc.ua.core.BrowseNextRequest req, BrowseListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThis service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.�Too large� in this context means that the server is not able to return a larger response or that the number of results to return exceeds the maximum number of results to return that was specified by the client in the original Browse request.
- Parameters:
req- the BrowseNextRequestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
translateBrowsePathsToNodeIds
public com.plccom.opc.ua.core.TranslateBrowsePathsToNodeIdsResponse translateBrowsePathsToNodeIds(com.plccom.opc.ua.core.BrowsePath... browsePaths) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionWith this service translates the server synchronously one or more browse paths to mNodeId�s- Parameters:
browsePaths- a list of browse paths for NodeIds to translate- Returns:
- a TranslateBrowsePathsToNodeIdsResponse Object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
translateBrowsePathsToNodeIds
public com.plccom.opc.ua.core.TranslateBrowsePathsToNodeIdsResponse translateBrowsePathsToNodeIds(com.plccom.opc.ua.core.TranslateBrowsePathsToNodeIdsRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionWith this service translates the server synchronously one or more browse paths to mNodeId�s- Parameters:
req- a list of browse paths in a TranslateBrowsePathsToNodeIdsRequest object- Returns:
- a TranslateBrowsePathsToNodeIdsResponse Object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
translateBrowsePathsToNodeIdsAsync
public void translateBrowsePathsToNodeIdsAsync(com.plccom.opc.ua.core.BrowsePath browsePaths, TranslateBrowsePathsToNodeIdsListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionWith this service translates the server asynchronously one or more browse paths to mNodeId�s- Parameters:
browsePaths- a BrowsePath objectcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
translateBrowsePathsToNodeIdsAsync
public void translateBrowsePathsToNodeIdsAsync(com.plccom.opc.ua.core.BrowsePath[] browsePaths, TranslateBrowsePathsToNodeIdsListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionWith this service translates the server asynchronously one or more browse paths to mNodeId�s- Parameters:
browsePaths- a array of BrowsePath objectscallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
translateBrowsePathsToNodeIdsAsync
public void translateBrowsePathsToNodeIdsAsync(com.plccom.opc.ua.core.TranslateBrowsePathsToNodeIdsRequest req, TranslateBrowsePathsToNodeIdsListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionWith this service translates the server asynchronously one or more browse paths to mNodeId�s- Parameters:
req- a list of browse paths in a TranslateBrowsePathsToNodeIdsRequest objectcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
registerNodes
public com.plccom.opc.ua.core.RegisterNodesResponse registerNodes(com.plccom.opc.ua.builtintypes.NodeId... nodesToRegister) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g. Write, Call). It allows servers to set up anything needed so that the access operations will be more efficient. Service is only available if the server supports registered read write- Parameters:
nodesToRegister- one or more NodeIds, Nodes to register- Returns:
- a RegisterNodesResponse object including the registered NodeIds
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
registerNodes
public com.plccom.opc.ua.core.RegisterNodesResponse registerNodes(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.NodeId... nodesToRegister) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g. Write, Call). It allows servers to set up anything needed so that the access operations will be more efficient. Service is only available if the server supports registered read write- Parameters:
requestHeader- a RequestHeader object, maybe nullnodesToRegister- one or more NodeIds, Nodes to register- Returns:
- a RegisterNodesResponse object including the registered NodeIds
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
registerNodes
public com.plccom.opc.ua.core.RegisterNodesResponse registerNodes(com.plccom.opc.ua.core.RegisterNodesRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g. Write, Call). It allows servers to set up anything needed so that the access operations will be more efficient. Service is only available if the server supports registered read write- Parameters:
req- a RegisterNodesRequest object including one or more NodeIds to register- Returns:
- a RegisterNodesResponse object object including the registered NodeIds
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
registerNodesAsync
public void registerNodesAsync(com.plccom.opc.ua.builtintypes.NodeId[] nodesToRegister, RegisterNodesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g. Write, Call). It allows servers to set up anything needed so that the access operations will be more efficient. Service is only available if the server supports registered read write- Parameters:
nodesToRegister- one or more NodeIds, Nodes to registercallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
registerNodesAsync
public void registerNodesAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.NodeId[] nodesToRegister, RegisterNodesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g. Write, Call). It allows servers to set up anything needed so that the access operations will be more efficient. Service is only available if the server supports registered read write- Parameters:
requestHeader- a RequestHeader object, maybe nullnodesToRegister- one or more NodeIds, Nodes to registercallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
registerNodesAsync
public void registerNodesAsync(com.plccom.opc.ua.core.RegisterNodesRequest req, RegisterNodesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g. Write, Call). It allows servers to set up anything needed so that the access operations will be more efficient. Service is only available if the server supports registered read write- Parameters:
req- a RegisterNodesRequest object including one or more NodeIds to registercallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
unregisterNodes
public com.plccom.opc.ua.core.UnregisterNodesResponse unregisterNodes(com.plccom.opc.ua.builtintypes.NodeId... nodesToUnRegister) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g. Write, Call). Service is only available if the server supports registered read write- Parameters:
nodesToUnRegister- one or more NodeIds, Nodes to unregister- Returns:
- a UnregisterNodesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
unregisterNodes
public com.plccom.opc.ua.core.UnregisterNodesResponse unregisterNodes(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.NodeId... nodesToUnRegister) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g. Write, Call). Service is only available if the server supports registered read write- Parameters:
requestHeader- a RequestHeader object, maybe nullnodesToUnRegister- one or more NodeIds, Nodes to unregister- Returns:
- a UnregisterNodesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
unregisterNodes
public com.plccom.opc.ua.core.UnregisterNodesResponse unregisterNodes(com.plccom.opc.ua.core.UnregisterNodesRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g. Write, Call). Service is only available if the server supports registered read write- Parameters:
req- a UnregisterNodesRequest object including one or more NodeIds to unregister- Returns:
- a UnregisterNodesResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
unregisterNodesAsync
public void unregisterNodesAsync(com.plccom.opc.ua.builtintypes.NodeId[] nodesToUnregister, UnregisterNodesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g. Write, Call). Service is only available if the server supports registered read write- Parameters:
nodesToUnregister- array of NodeIds to unregistercallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
unregisterNodesAsync
public void unregisterNodesAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.NodeId[] nodesToUnregister, UnregisterNodesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g. Write, Call). Service is only available if the server supports registered read write- Parameters:
requestHeader- a RequestHeader object, maybe nullnodesToUnregister- array of NodeIdscallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
unregisterNodesAsync
public void unregisterNodesAsync(com.plccom.opc.ua.core.UnregisterNodesRequest req, UnregisterNodesListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionThe UnregisterNodes service can be used by clients to unregister the nodes that they know they will access repeatedly (e.g. Write, Call). Service is only available if the server supports registered read write- Parameters:
req- a UnregisterNodesRequest object including one or more NodeIds to unregistercallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readValue
public com.plccom.opc.ua.core.ReadResponse readValue(com.plccom.opc.ua.builtintypes.NodeId... NodeIdsToRead) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead synchronously values of one or more NodeIds- Parameters:
NodeIdsToRead- one or more NodeIds- Returns:
- a ReadResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
read
public com.plccom.opc.ua.core.ReadResponse read(com.plccom.opc.ua.builtintypes.NodeId nodeIdToRead, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead synchronously attributes or values of one or more NodeIds- Parameters:
nodeIdToRead- a mNodeId for readingattributeId- a attribute identifier- Returns:
- a ReadResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
read
public com.plccom.opc.ua.core.ReadResponse read(com.plccom.opc.ua.builtintypes.NodeId nodeIdToRead, UaAttributes attribute) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead synchronously attributes or values of one or more NodeIds- Parameters:
nodeIdToRead- a mNodeId for readingattribute- a attribute identifier- Returns:
- a ReadResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
read
public com.plccom.opc.ua.core.ReadResponse read(com.plccom.opc.ua.builtintypes.NodeId[] nodeIdsToRead, UaAttributes attribute) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead synchronously attributes or values of one or more NodeIds- Parameters:
nodeIdsToRead- one or more NodeIds for readingattribute- a attribute identifier- Returns:
- a ReadResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
read
public com.plccom.opc.ua.core.ReadResponse read(com.plccom.opc.ua.builtintypes.NodeId[] nodeIdsToRead, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead synchronously attributes or values of one or more NodeIds- Parameters:
nodeIdsToRead- one or more NodeIds for readingattributeId- a attribute identifier- Returns:
- a ReadResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
read
public com.plccom.opc.ua.core.ReadResponse read(com.plccom.opc.ua.core.ReadValueId... nodesToRead) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead synchronously one attributes or values of one or more nodes.- Parameters:
nodesToRead- a List of ReadValueId�s identifying the nodes and attributes to read.- Returns:
- ReadResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
read
public com.plccom.opc.ua.core.ReadResponse read(Double maxAge, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, com.plccom.opc.ua.core.ReadValueId... nodesToRead) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Read synchronously one attributes or values of one or more nodes.- Parameters:
maxAge- maximal age of the value to read. If parameter = 0 or maxAge greater the age of mNodeId, the server read a new value from the data source. Otherwise the the server send the cached value. Values smaller 0 are not allowed.timestampsToReturn- the requested TimestampsToReturnnodesToRead- a List of ReadValueId�s identifying the nodes and attributes to read.- Returns:
- ReadResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
read
public com.plccom.opc.ua.core.ReadResponse read(com.plccom.opc.ua.core.ReadRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead synchronously one attributes or values of one or more nodes.- Parameters:
req- a ReadRequest object- Returns:
- ReadResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readFullNode
public com.plccom.opc.ua.core.ReadResponse readFullNode(com.plccom.opc.ua.builtintypes.NodeId nodeId) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionReads all base attributes of a node from the OPC UA server, including NodeId, NodeClass, BrowseName, DisplayName, Description, WriteMask and UserWriteMask.- Parameters:
nodeId- theNodeIdof the node to read- Returns:
- a
ReadResponsecontaining the values of all base attributes - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readFullNode
public com.plccom.opc.ua.core.ReadResponse readFullNode(String browsePath) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Reads all base attributes of a node identified by its browse path string.- Parameters:
browsePath- the dot-separated browse path identifying the node (e.g. "Objects.MyFolder.MyVariable")- Returns:
- a
ReadResponsecontaining the values of all base attributes - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readFullNode
public com.plccom.opc.ua.core.ReadResponse readFullNode(ArrayList<com.plccom.opc.ua.builtintypes.QualifiedName> browsePath) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Reads all base attributes of a node identified by its browse path.- Parameters:
browsePath- the browse path as a list ofQualifiedNamesegments- Returns:
- a
ReadResponsecontaining the values of all base attributes - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readValues
public com.plccom.opc.ua.core.ReadResponse readValues(com.plccom.opc.ua.builtintypes.NodeId[] nodeIds) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionReads the current values of multiple variable nodes from the OPC UA server. Returns both the data values and a per-node status indicating success or failure.- Parameters:
nodeIds- the array ofNodeIdobjects identifying the variable nodes to read- Returns:
- a
ReadResponsecontaining aDataValuefor each requested node; check each result's status code to determine success or failure - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readValueAsync
public void readValueAsync(com.plccom.opc.ua.builtintypes.NodeId nodeIdToRead, ReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead asynchronously the value of a node- Parameters:
nodeIdToRead- a mNodeId for readingcallback- the callback interface for asynchronous operations- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readValuesAsync
public void readValuesAsync(com.plccom.opc.ua.builtintypes.NodeId[] nodeIdsToRead, ReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead asynchronously the values of one or more nodes- Parameters:
nodeIdsToRead- one or more NodeIds for readingcallback- the callback interface for asynchronous operations- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readAsync
public void readAsync(com.plccom.opc.ua.builtintypes.NodeId nodeIdToRead, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId, ReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead asynchronously one attributes or values of a node.- Parameters:
nodeIdToRead- a mNodeId for readingattributeId- a attribute identifiercallback- the callback interface for asynchronous operations- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readAsync
public void readAsync(com.plccom.opc.ua.builtintypes.NodeId[] nodeIdsToRead, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId, ReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead asynchronously one attributes or values of one or more nodes.- Parameters:
nodeIdsToRead- one or more NodeIds for readingattributeId- a attribute identifiercallback- the callback interface for asynchronous operations- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readAsync
public void readAsync(com.plccom.opc.ua.core.ReadValueId nodeToRead, ReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead asynchronously one attributes or values of a node.- Parameters:
nodeToRead- a ReadValueId identifying the node or attribute to read.callback- the callback interface for asynchronous operations- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readAsync
public void readAsync(com.plccom.opc.ua.core.ReadValueId[] nodesToRead, ReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead asynchronously one attributes or values of one or more nodes.- Parameters:
nodesToRead- a array of ReadValueId objects identifying the nodes or attributes to read.callback- the callback interface for asynchronous operations- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readAsync
public void readAsync(Double maxAge, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, com.plccom.opc.ua.core.ReadValueId nodesToRead, ReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Read asynchronously one attributes or values of one or more nodes.- Parameters:
maxAge- maximal age of the value to read. If parameter = 0 or maxAge greater the age of mNodeId, the server read a new value from the data source. Otherwise the the server send the cached value. Values smaller 0 are not allowed.timestampsToReturn- the requested TimestampsToReturnnodesToRead- a ReadValueId identifying the node or attribute to read.callback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readAsync
public void readAsync(Double maxAge, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, com.plccom.opc.ua.core.ReadValueId[] nodesToRead, ReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Read asynchronously one attributes or values of one or more nodes.- Parameters:
maxAge- maximal age of the value to read. If parameter = 0 or maxAge greater the age of mNodeId, the server read a new value from the data source. Otherwise the the server send the cached value. Values smaller 0 are not allowed.timestampsToReturn- the requested TimestampsToReturnnodesToRead- a List of ReadValueId�s identifying the nodes and attributescallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readAsync
public void readAsync(com.plccom.opc.ua.core.ReadRequest req, ReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead asynchronously one attributes or values of one or more nodes.- Parameters:
req- a ReadRequest objectcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
writeValue
public com.plccom.opc.ua.builtintypes.StatusCode writeValue(com.plccom.opc.ua.builtintypes.NodeId nodeToWrite, Object valueToWrite) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException, IllegalArgumentExceptionWrite synchronously attribute or value to a nodes with attributeId Value- Parameters:
nodeToWrite- the node identifier for writingvalueToWrite- the value for writing- Returns:
- a StatusCode object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication errorIllegalArgumentException- Illegal data type while converting to target datatype Variant. Please check the parameter valueToWrite
-
write
public com.plccom.opc.ua.builtintypes.StatusCode write(com.plccom.opc.ua.builtintypes.NodeId nodeToWrite, Object valueToWrite, UaAttributes attribute) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException, IllegalArgumentExceptionWrite synchronously attribute or value to a nodes.- Parameters:
nodeToWrite- the node identifier for writingvalueToWrite- the value for writingattribute- the attribute identifier- Returns:
- a StatusCode object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication errorIllegalArgumentException- Illegal data type while converting to target datatype Variant. Please check the parameter valueToWrite
-
write
public com.plccom.opc.ua.builtintypes.StatusCode write(com.plccom.opc.ua.builtintypes.NodeId nodeToWrite, Object valueToWrite, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException, IllegalArgumentExceptionWrite synchronously attribute or value to a nodes.- Parameters:
nodeToWrite- the node identifier for writingvalueToWrite- the value for writingattributeId- the attribute identifier- Returns:
- a StatusCode object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication errorIllegalArgumentException- Illegal data type while converting to target datatype Variant. Please check the parameter valueToWrite
-
write
public com.plccom.opc.ua.core.WriteResponse write(UaWriteValue... nodesToWrite) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Write synchronously attributes or values to one or more nodes.- Parameters:
nodesToWrite- one or more WriteValue with mNodeId�s and values for writing- Returns:
- a WriteResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
write
public com.plccom.opc.ua.core.WriteResponse write(com.plccom.opc.ua.core.WriteRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionWrite synchronously attributes or values to one or more nodes.- Parameters:
req- a WriteRequest object- Returns:
- a WriteResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
writeValueAsync
public void writeValueAsync(com.plccom.opc.ua.builtintypes.NodeId nodeToWrite, Object valueToWrite, WriteListener callback) throws IllegalArgumentException, com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionWrite asynchronously attributes or values to a node.- Parameters:
nodeToWrite- the node identifier for writingvalueToWrite- the value for writingcallback- the callback interface- Throws:
IllegalArgumentException- Illegal data type while converting to target datatype Variant. Please check the parameter valueToWritecom.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
writeAsync
public void writeAsync(com.plccom.opc.ua.builtintypes.NodeId nodeToWrite, Object valueToWrite, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId, WriteListener callback) throws IllegalArgumentException, com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionWrite asynchronously attributes or values to a node.- Parameters:
nodeToWrite- the node identifier for writingvalueToWrite- the value for writingattributeId- the attribute identifiercallback- the callback interface- Throws:
IllegalArgumentException- Illegal data type while converting to target datatype Variant. Please check the parameter valueToWritecom.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
writeAsync
public void writeAsync(UaWriteValue nodesToWrite, WriteListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Write asynchronously attributes or values to one node.- Parameters:
nodesToWrite- a WriteValue object with mNodeId and value for writingcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
writeAsync
public void writeAsync(UaWriteValue[] nodesToWrite, WriteListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultException
Write asynchronously attributes or values to one or more nodes.- Parameters:
nodesToWrite- one or more WriteValue objects with mNodeId�s and values for writingcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
writeAsync
public void writeAsync(com.plccom.opc.ua.core.WriteRequest req, WriteListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionWrite asynchronously attributes or values to one or more nodes.- Parameters:
req- a WriteRequest objectcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
historyRead
public com.plccom.opc.ua.core.HistoryReadResponse historyRead(com.plccom.opc.ua.builtintypes.ExtensionObject historyReadDetails, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, Boolean releaseContinuationPoints, com.plccom.opc.ua.core.HistoryReadValueId... nodesToRead) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead synchronously one or more historical values or historical events from server- Parameters:
historyReadDetails- the types of history readtimestampsToReturn- the requested TimestampsToReturnreleaseContinuationPoints- if true release and reset continuationPoints after read at server. Otherwise the continuationPoints will be used to reading the next set of historical datanodesToRead- a List of ReadValueId�s identifying the nodes and attributes- Returns:
- a HistoryReadResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
historyRead
public com.plccom.opc.ua.core.HistoryReadResponse historyRead(com.plccom.opc.ua.core.HistoryReadRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead synchronously one or more historical values or historical events from server- Parameters:
req- a HistoryReadRequest object- Returns:
- a HistoryReadResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
historyReadAsync
public void historyReadAsync(com.plccom.opc.ua.builtintypes.ExtensionObject historyReadDetails, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, Boolean releaseContinuationPoints, com.plccom.opc.ua.core.HistoryReadValueId nodesToRead, HistoryReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead asynchronously one historical values or historical events from server- Parameters:
historyReadDetails- the types of history readtimestampsToReturn- the requested TimestampsToReturnreleaseContinuationPoints- if true release and reset continuationPoints after read at server. Otherwise the continuationPoints will be used to reading the next set of historical datanodesToRead- ReadValueId identifying the nodes and attributescallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
historyReadAsync
public void historyReadAsync(com.plccom.opc.ua.builtintypes.ExtensionObject historyReadDetails, com.plccom.opc.ua.core.TimestampsToReturn timestampsToReturn, Boolean releaseContinuationPoints, com.plccom.opc.ua.core.HistoryReadValueId[] nodesToRead, HistoryReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead asynchronously one or more historical values or historical events from server- Parameters:
historyReadDetails- the types of history readtimestampsToReturn- the requested TimestampsToReturnreleaseContinuationPoints- if true release and reset continuationPoints after read at server. Otherwise the continuationPoints will be used to reading the next set of historical datanodesToRead- a List of ReadValueId�s identifying the nodes and attributescallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
historyReadAsync
public void historyReadAsync(com.plccom.opc.ua.core.HistoryReadRequest req, HistoryReadListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRead asynchronously one or more historical values or historical events from server- Parameters:
req- a HistoryReadRequest objectcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
historyUpdate
public com.plccom.opc.ua.core.HistoryUpdateResponse historyUpdate(com.plccom.opc.ua.builtintypes.ExtensionObject... historyUpdateDetails) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionUpdate synchronously one or more historical values or historical events at server- Parameters:
historyUpdateDetails- a list of update details- Returns:
- a HistoryUpdateResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
historyUpdate
public com.plccom.opc.ua.core.HistoryUpdateResponse historyUpdate(com.plccom.opc.ua.core.HistoryUpdateRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionUpdate synchronously one or more historical values or historical events at server- Parameters:
req- a HistoryUpdateRequest object- Returns:
- a HistoryUpdateResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
historyUpdateAsync
public void historyUpdateAsync(com.plccom.opc.ua.builtintypes.ExtensionObject historyUpdateDetails, HistoryUpdateListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionUpdate asynchronously one or more historical values or historical events at server- Parameters:
historyUpdateDetails- a object with update detailscallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
historyUpdateAsync
public void historyUpdateAsync(com.plccom.opc.ua.builtintypes.ExtensionObject[] historyUpdateDetails, HistoryUpdateListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionUpdate asynchronously one or more historical values or historical events at server- Parameters:
historyUpdateDetails- a list of update detailscallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
historyUpdateAsync
public void historyUpdateAsync(com.plccom.opc.ua.core.HistoryUpdateRequest req, HistoryUpdateListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionUpdate asynchronously one or more historical values or historical events at server- Parameters:
req- a HistoryUpdateRequest objectcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readRaw
public com.plccom.opc.ua.core.HistoryData readRaw(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, boolean isReadModified) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionReads raw historical data for a single node within the specified time range.- Parameters:
nodeId- theNodeIdof the node to readstartTime- the beginning of the time range (inclusive)endTime- the end of the time range (inclusive)isReadModified- iftrue, only modified (inserted/replaced) values are returned- Returns:
- a
HistoryDataobject containing the raw historical values - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readRaw
public com.plccom.opc.ua.core.HistoryData readRaw(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, com.plccom.opc.ua.builtintypes.UnsignedInteger numValuesPerNode, boolean isReadModified) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionReads raw historical data for a single node within the specified time range with an optional limit on the number of returned values.- Parameters:
nodeId- theNodeIdof the node to readstartTime- the beginning of the time range (inclusive)endTime- the end of the time range (inclusive)numValuesPerNode- the maximum number of values to return; use 0 for no limitisReadModified- iftrue, only modified (inserted/replaced) values are returned- Returns:
- a
HistoryDataobject containing the raw historical values - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readRaw
public com.plccom.opc.ua.core.HistoryReadResponse readRaw(com.plccom.opc.ua.core.HistoryReadValueId[] nodesToRead, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, com.plccom.opc.ua.builtintypes.UnsignedInteger numValuesPerNode, boolean isReadModified) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionReads raw historical data for multiple nodes within the specified time range.- Parameters:
nodesToRead- the nodes to readstartTime- the beginning of the time range (inclusive)endTime- the end of the time range (inclusive)numValuesPerNode- the maximum number of values to return per node; use 0 for no limitisReadModified- iftrue, only modified (inserted/replaced) values are returned- Returns:
- a
HistoryReadResponsecontaining one result per requested node - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readAtTime
public com.plccom.opc.ua.core.HistoryData readAtTime(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime startTime, long numValuesPerNode, long timeStepMs, boolean useSimpleBounds) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionReads historical data at evenly spaced time intervals for a single node.- Parameters:
nodeId- theNodeIdof the node to readstartTime- the starting timestampnumValuesPerNode- the number of evenly spaced timestamps to readtimeStepMs- the time interval in milliseconds between timestampsuseSimpleBounds- iftrue, the server uses simple bounding value logic- Returns:
- a
HistoryDataobject containing the values at the computed timestamps - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readAtTime
public com.plccom.opc.ua.core.HistoryReadResponse readAtTime(com.plccom.opc.ua.core.HistoryReadValueId[] nodesToRead, com.plccom.opc.ua.builtintypes.DateTime startTime, long numValuesPerNode, long timeStepMs, boolean useSimpleBounds) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionReads historical data at evenly spaced time intervals for multiple nodes.- Parameters:
nodesToRead- the nodes to readstartTime- the starting timestampnumValuesPerNode- the number of evenly spaced timestamps to readtimeStepMs- the time interval in milliseconds between timestampsuseSimpleBounds- iftrue, the server uses simple bounding value logic- Returns:
- a
HistoryReadResponsecontaining one result per requested node - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readProcessed
public com.plccom.opc.ua.core.HistoryData readProcessed(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.NodeId aggregate, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, double processingInterval) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionReads processed (aggregated) historical data for a single node.- Parameters:
nodeId- theNodeIdof the node to readaggregate- theNodeIdof the aggregate function (e.g.Identifiers.AggregateFunction_Average)startTime- the beginning of the time range (inclusive)endTime- the end of the time range (inclusive)processingInterval- the processing interval in milliseconds- Returns:
- a
HistoryDataobject containing the aggregated values - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
readProcessed
public com.plccom.opc.ua.core.HistoryReadResponse readProcessed(com.plccom.opc.ua.core.HistoryReadValueId[] nodesToRead, com.plccom.opc.ua.builtintypes.NodeId aggregate, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, double processingInterval) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionReads processed (aggregated) historical data for multiple nodes.- Parameters:
nodesToRead- the nodes to readaggregate- theNodeIdof the aggregate functionstartTime- the beginning of the time range (inclusive)endTime- the end of the time range (inclusive)processingInterval- the processing interval in milliseconds- Returns:
- a
HistoryReadResponsecontaining one result per requested node - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
insertHistoryValues
public com.plccom.opc.ua.core.HistoryUpdateResult insertHistoryValues(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DataValue[] values) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionInserts new historical data values for the specified node.- Parameters:
nodeId- theNodeIdof the nodevalues- the data values to insert, each containing a value and source timestamp- Returns:
- a
HistoryUpdateResultindicating the result of the operation - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
updateHistoryValues
public com.plccom.opc.ua.core.HistoryUpdateResult updateHistoryValues(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DataValue[] values) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionUpdates existing historical data values for the specified node. The server replaces values at matching timestamps and may insert at new timestamps.- Parameters:
nodeId- theNodeIdof the nodevalues- the data values to update- Returns:
- a
HistoryUpdateResultindicating the result of the operation - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
replaceHistoryValues
public com.plccom.opc.ua.core.HistoryUpdateResult replaceHistoryValues(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DataValue[] values) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionReplaces existing historical data values for the specified node. Only values at timestamps that already exist are replaced.- Parameters:
nodeId- theNodeIdof the nodevalues- the replacement data values- Returns:
- a
HistoryUpdateResultindicating the result of the operation - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
removeHistoryValues
public com.plccom.opc.ua.core.HistoryUpdateResult removeHistoryValues(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DataValue[] values) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionRemoves historical data values at the specified timestamps for the given node.- Parameters:
nodeId- theNodeIdof the nodevalues- the data values identifying the timestamps to remove- Returns:
- a
HistoryUpdateResultindicating the result of the operation - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteRaw
public com.plccom.opc.ua.core.HistoryUpdateResult deleteRaw(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime startTime, com.plccom.opc.ua.builtintypes.DateTime endTime, boolean isModified) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionDeletes raw historical data for the specified node within the given time range.- Parameters:
nodeId- theNodeIdof the nodestartTime- the beginning of the time range (inclusive)endTime- the end of the time range (inclusive)isModified- iftrue, only modified values are deleted- Returns:
- a
HistoryUpdateResultindicating the result of the operation - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteAtTime
public com.plccom.opc.ua.core.HistoryUpdateResult deleteAtTime(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime startTime, long numValuesPerNode, long timeStepMs) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionDeletes historical data at evenly spaced time intervals for the specified node.- Parameters:
nodeId- theNodeIdof the nodestartTime- the starting timestampnumValuesPerNode- the number of evenly spaced timestamps to deletetimeStepMs- the time interval in milliseconds between timestamps- Returns:
- a
HistoryUpdateResultindicating the result of the operation - Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
deleteAtTime
public com.plccom.opc.ua.core.HistoryUpdateResult deleteAtTime(com.plccom.opc.ua.builtintypes.NodeId nodeId, com.plccom.opc.ua.builtintypes.DateTime[] reqTimes) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionDeletes history values at the specified exact timestamps.- Parameters:
nodeId- the NodeId of the variablereqTimes- the exact timestamps to delete- Returns:
- the history update result
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- if the server returns a service faultcom.plccom.opc.ua.common.ServiceResultException- if the operation fails
-
publish
public com.plccom.opc.ua.core.PublishResponse publish(com.plccom.opc.ua.core.SubscriptionAcknowledgement... subscriptionAcknowledgements) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Publish service request.- Parameters:
subscriptionAcknowledgements- one or more SubscriptionAcknowledgement objects- Returns:
- a PublishResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
publish
public com.plccom.opc.ua.core.PublishResponse publish(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.SubscriptionAcknowledgement... subscriptionAcknowledgements) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Publish service request.- Parameters:
requestHeader- a RequestHeader objectsubscriptionAcknowledgements- one or more SubscriptionAcknowledgement objects- Returns:
- a PublishResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
publish
public com.plccom.opc.ua.core.PublishResponse publish(com.plccom.opc.ua.core.PublishRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Publish service request.- Parameters:
req- a PublishRequest object- Returns:
- a PublishResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
publishAsync
public void publishAsync(com.plccom.opc.ua.core.SubscriptionAcknowledgement subscriptionAcknowledgement, PublishListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Publish service request.- Parameters:
subscriptionAcknowledgement- a SubscriptionAcknowledgement objectcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
publishAsync
public void publishAsync(com.plccom.opc.ua.core.SubscriptionAcknowledgement[] subscriptionAcknowledgements, PublishListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Publish service request.- Parameters:
subscriptionAcknowledgements- a array of SubscriptionAcknowledgement objectscallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
publishAsync
public void publishAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.SubscriptionAcknowledgement subscriptionAcknowledgement, PublishListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Publish service request.- Parameters:
requestHeader- a RequestHeader objectsubscriptionAcknowledgement- a SubscriptionAcknowledgement objectcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
publishAsync
public void publishAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.SubscriptionAcknowledgement[] subscriptionAcknowledgements, PublishListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Publish service request.- Parameters:
requestHeader- a RequestHeader objectsubscriptionAcknowledgements- a array of SubscriptionAcknowledgement objectscallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
publishAsync
public void publishAsync(com.plccom.opc.ua.core.PublishRequest req, PublishListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Publish service request.- Parameters:
req- the requestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
republish
public com.plccom.opc.ua.core.RepublishResponse republish(com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger retransmitSequenceNumber) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Republish service request.- Parameters:
subscriptionId- the subscription idretransmitSequenceNumber- the retransmit sequence number- Returns:
- the response
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
republish
public com.plccom.opc.ua.core.RepublishResponse republish(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger retransmitSequenceNumber) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Republish service request.- Parameters:
requestHeader- a RequestHeader objectsubscriptionId- the subscription idretransmitSequenceNumber- the retransmit sequence number- Returns:
- the response
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
republish
public com.plccom.opc.ua.core.RepublishResponse republish(com.plccom.opc.ua.core.RepublishRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Republish service request.- Parameters:
req- the request- Returns:
- the response
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
republishAsync
public void republishAsync(com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger retransmitSequenceNumber, RepublishListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Republish service request.- Parameters:
subscriptionId- the subscription idretransmitSequenceNumber- the retransmit sequence numbercallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
republishAsync
public void republishAsync(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.builtintypes.UnsignedInteger subscriptionId, com.plccom.opc.ua.builtintypes.UnsignedInteger retransmitSequenceNumber, RepublishListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Republish service request.- Parameters:
requestHeader- a RequestHeader objectsubscriptionId- the subscription idretransmitSequenceNumber- the retransmit sequence numbercallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
republishAsync
public void republishAsync(com.plccom.opc.ua.core.RepublishRequest req, RepublishListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Republish service request.- Parameters:
req- the requestcallback- the callback interface- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
call
public com.plccom.opc.ua.core.CallMethodResult[] call(com.plccom.opc.ua.core.CallMethodRequest... methodsToCall) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Call service request- Parameters:
methodsToCall- one or more CallMethodRequest- Returns:
- a one or more CallMethodResult objects
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
call
public com.plccom.opc.ua.core.CallMethodResult[] call(com.plccom.opc.ua.core.RequestHeader requestHeader, com.plccom.opc.ua.core.CallMethodRequest... methodsToCall) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Call service request.- Parameters:
requestHeader- a valid RequestHeader objectmethodsToCall- one or more CallMethodRequest- Returns:
- a one or more CallMethodResult objects
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
call
public com.plccom.opc.ua.core.CallResponse call(com.plccom.opc.ua.core.CallRequest req) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionSynchronous Call service request.- Parameters:
req- a valid CallRequest object- Returns:
- a CallResponse object
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
callAsync
public void callAsync(com.plccom.opc.ua.core.CallRequest req, CallListener callback) throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionAsynchronous Call service request.- Parameters:
req- a valid CallRequest objectcallback- the callback interface for asynchronous operations- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
createSessionChannel
public UaSessionChannel createSessionChannel(com.plccom.opc.ua.core.EndpointDescription endpoint, String sessionName) throws com.plccom.opc.ua.common.ServiceResultException
Creates a secure channel and an unactivated session channel.The channel needs to be activated separately.
To close the object, both secure channel and the session must be close separately. SessionChannel.closeSession() SessionChannel.closeSecureChannel()
- Parameters:
endpoint- endpoint descriptionsessionName- optional name of session- Returns:
- session channel
- Throws:
com.plccom.opc.ua.common.ServiceResultException- on errors
-
createSessionChannel
public UaSessionChannel createSessionChannel(String endpointUrl, String sessionName) throws com.plccom.opc.ua.common.ServiceResultException
Creates a secure channel and an unactivated session channel.The channel needs to be activated separately.
To close the object, both secure channel and the session must be close separately. SessionChannel.closeSession() SessionChannel.closeSecureChannel()
- Parameters:
endpointUrl- endpoint identifier and socket addresssessionName- optional name of session- Returns:
- the created Session channel
- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException
-
createSessionChannel
public UaSessionChannel createSessionChannel(String connectUrl, String endpointUri, String sessionName) throws com.plccom.opc.ua.common.ServiceResultException
Creates a secure channel and an unactivated session channel.The channel needs to be activated separately.
To close the object, both secure channel and the session must be close separately. SessionChannel.closeSession() SessionChannel.closeSecureChannel()
- Parameters:
connectUrl- address that contains the socket address to the endpointendpointUri- endpoint identifiersessionName- optional name of session- Returns:
- the new created session channel
- Throws:
com.plccom.opc.ua.common.ServiceResultException- on communication error
-
createSession
public com.plccom.opc.ua.application.Session createSession(com.plccom.opc.ua.transport.SecureChannel channel, String sessionName) throws IllegalArgumentException, com.plccom.opc.ua.common.ServiceResultExceptionCreate a new session on a server- Parameters:
channel- open channel to usesessionName- session name - if null a random GUID is used to generate the name- Returns:
- the session
- Throws:
IllegalArgumentException- Illegal data type while converting to target datatype Variant. Please check the parameter valueToWritecom.plccom.opc.ua.common.ServiceResultException- on communication error
-
connect
public void connect() throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionconnecting the Ua OpcUaClient instance to OPC Ua server- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
getLicenceMessage
public String getLicenceMessage()
returns the current licence message with actual details- Returns:
- the current licence message
-
getComplexTypeSystem
public UaComplexTypeSystem getComplexTypeSystem()
Creates a newUaComplexTypeSystemfor this client session.Call
load()on the returned instance to browse the server's DataType hierarchy and cache allStructureDefinitionobjects. After loading, usedecode(ExtensionObject)to decode complex type values intoUaStructuredValueinstances.Example:
UaComplexTypeSystem typeSystem = client.getComplexTypeSystem(); typeSystem.load(); UaStructuredValue value = typeSystem.decode(extensionObject); System.out.println(value.getField("Temperature"));- Returns:
- a new UaComplexTypeSystem bound to this session
-
startReverseConnectListener
public void startReverseConnectListener(String listenUrl) throws Exception
Configures the URL on which this client listens for incoming Reverse Connect connections from the server. The stack opens the ServerSocket internally. Call this beforeconnectReverse(int).- Parameters:
listenUrl- the URL to listen on, e.g. "opc.tcp://localhost:48500"- Throws:
Exception- if the URL is invalid
-
stopReverseConnectListener
public void stopReverseConnectListener()
Resets the reverse connect listener configuration.
-
connectReverse
public void connectReverse(int timeoutMs) throws ExceptionWaits for an incoming ReverseHello from the server and establishes a session. CallstartReverseConnectListener(String)first. Spec-compliant per OPC UA Part 6 §7.1.3: the session runs over the same TCP connection initiated by the server. The stack handles the ReverseHello -> Hello -> Acknowledge handshake on the accepted socket.- Parameters:
timeoutMs- timeout in milliseconds to wait for the server. Default: 60000.- Throws:
IllegalStateException- if the listener has not been startedException- on connection or session errors
-
connectReverse
public void connectReverse() throws ExceptionWaits for an incoming ReverseHello with default timeout of 60 seconds.- Throws:
Exception- if the connection fails or times out
-
disconnect
public void disconnect() throws com.plccom.opc.ua.common.ServiceFaultException, com.plccom.opc.ua.common.ServiceResultExceptionDeprecated.Use close() insteaddisconnect the Ua OpcUaClient from OPC Ua server- Throws:
com.plccom.opc.ua.common.ServiceFaultException- on error while executing the operationcom.plccom.opc.ua.common.ServiceResultException- on communication error
-
addSessionConnectionStateChangeListener
public boolean addSessionConnectionStateChangeListener(SessionConnectionStateChangeListener handler)
append a SessionConnectionStateChangeListener object to event register- Parameters:
handler- a SessionConnectionStateChangeListener object- Returns:
- true (as specified by
Collection#add)
-
removeSessionConnectionStateChangeListener
public boolean removeSessionConnectionStateChangeListener(SessionConnectionStateChangeListener handler)
remove a SessionConnectionStateChangeListener object from event register- Parameters:
handler- a SessionConnectionStateChangeListener element to be removed from this list, if present- Returns:
- true if this list contained the specified element
-
addSessionKeepAliveListener
public boolean addSessionKeepAliveListener(SessionKeepAliveListener handler)
append a SessionKeepAliveListener object to event register- Parameters:
handler- a SessionKeepAliveListener object- Returns:
- true (as specified by
Collection#add)
-
removeSessionKeepAliveListener
public boolean removeSessionKeepAliveListener(SessionKeepAliveListener handler)
remove a SessionKeepAliveListener object from event register- Parameters:
handler- a SessionKeepAliveListener element to be removed from this list, if present- Returns:
- true if this list contained the specified element
-
onSessionKeepAlive
public void onSessionKeepAlive(com.plccom.opc.ua.core.ServerStatusDataType serverStatusDataType, com.plccom.opc.ua.core.ServerState serverState)Description copied from interface:SessionKeepAliveListenerthe event OnSessionKeepAlive by every server keepalive event- Specified by:
onSessionKeepAlivein interfaceSessionKeepAliveListener- Parameters:
serverStatusDataType- the full ServerStatusDataType object from serverserverState- the isolated ServerState from ServerStatusDataType object
-
onSessionConnectionStateChanged
public void onSessionConnectionStateChanged(boolean isConnected)
Description copied from interface:SessionConnectionStateChangeListenerevent is called when the connection state of session changes- Specified by:
onSessionConnectionStateChangedin interfaceSessionConnectionStateChangeListener- Parameters:
isConnected- is session connected or not
-
getNextRequestHandle
public com.plccom.opc.ua.builtintypes.UnsignedInteger getNextRequestHandle()
function returns the nextUnsignedIntegerfrom a atomic sequence, for using as unique request handle- Returns:
- the next
UnsignedIntegerfrom a atomic sequence, for using as unique request handle
-
-