Module org.eclipse.milo.opcua.sdk.client
Package org.eclipse.milo.opcua.sdk.client

Class OpcUaClient

java.lang.Object
org.eclipse.milo.opcua.sdk.client.OpcUaClient
public class OpcUaClient extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    SDK_VERSION
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpcUaClient(OpcUaClientConfig config, org.eclipse.milo.opcua.stack.transport.client.OpcClientTransport transport)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addFaultListener(ServiceFaultListener faultListener)
     
    org.eclipse.milo.opcua.stack.core.types.structured.AddNodesResponse
    addNodes(List<org.eclipse.milo.opcua.stack.core.types.structured.AddNodesItem> nodesToAdd)
    Add one or more Nodes to the AddressSpace hierarchy.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.AddNodesResponse>
    addNodesAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.AddNodesItem> nodesToAdd)
    Add one or more Nodes to the AddressSpace hierarchy.
    org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesResponse
    addReferences(List<org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesItem> referencesToAdd)
    Add one or more References to one or more Nodes.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesResponse>
    addReferencesAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesItem> referencesToAdd)
    Add one or more References to one or more Nodes.
    void
    addSessionActivityListener(SessionActivityListener listener)
     
    void
    addSessionInitializer(SessionFsm.SessionInitializer initializer)
     
    void
    addSubscription(OpcUaSubscription subscription)
     
    List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult>
    browse(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse)
    Browse references of one or more Nodes.
    org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult
    browse(org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription nodeToBrowse)
    Browse references of a single Node.
    org.eclipse.milo.opcua.stack.core.types.structured.BrowseResponse
    browse(org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription viewDescription, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxReferencesPerNode, List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse)
    Browse references of one or more Nodes.
    CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult>>
    browseAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse)
    Browse a list of nodes, with no view and no max references specified.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult>
    browseAsync(org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription nodeToBrowse)
    Browse a single node, with no view and no max references specified.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResponse>
    browseAsync(org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription viewDescription, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxReferencesPerNode, List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse)
    Browse references of one or more Nodes.
    org.eclipse.milo.opcua.stack.core.types.structured.BrowseNextResponse
    browseNext(boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> continuationPoints)
    Request the next set of Browse or BrowseNext information that was too large to be sent in a single response.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseNextResponse>
    browseNextAsync(boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> continuationPoints)
    Request the next set of Browse or BrowseNext information that was too large to be sent in a single response.
    org.eclipse.milo.opcua.stack.core.types.structured.CallResponse
    call(List<org.eclipse.milo.opcua.stack.core.types.structured.CallMethodRequest> requests)
    Call (invoke) one or more methods.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CallResponse>
    callAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.CallMethodRequest> requests)
    Call (invoke) one or more methods.
    OpcUaClient
    connect()
    Connect the underlying transport and open a session.
    CompletableFuture<OpcUaClient>
    connectAsync()
    Connect the underlying transport and open a session.
    static OpcUaClient
    create(String endpointUrl)
    Select the first endpoint with no security that allows anonymous connections and create an OpcUaClient with the default configuration.
    static OpcUaClient
    create(String endpointUrl, Function<List<org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription>,Optional<org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription>> selectEndpoint, Consumer<org.eclipse.milo.opcua.stack.transport.client.tcp.OpcTcpClientTransportConfigBuilder> configureTransport, Consumer<OpcUaClientConfigBuilder> configureClient)
    Create and configure an OpcUaClient by selecting an EndpointDescription from a list of endpoints retrieved via the GetEndpoints service from the server at endpointUrl and building an OpcUaClientConfig using that endpoint.
    static OpcUaClient
    create(OpcUaClientConfig config)
    Create an OpcUaClient configured with config.
    static OpcUaClient
    create(OpcUaClientConfig config, Consumer<org.eclipse.milo.opcua.stack.transport.client.tcp.OpcTcpClientTransportConfigBuilder> configureTransport)
    Create an OpcUaClient configured with config.
    org.eclipse.milo.opcua.stack.core.types.structured.CreateMonitoredItemsResponse
    createMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest> itemsToCreate)
    Create and add one or more Monitored Items to a Subscription.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CreateMonitoredItemsResponse>
    createMonitoredItemsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest> itemsToCreate)
    Create and add one or more Monitored Items to a Subscription.
    org.eclipse.milo.opcua.stack.core.types.structured.CreateSubscriptionResponse
    createSubscription(double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, boolean publishingEnabled, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)
    Create a new Subscription belonging to this client's Session.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CreateSubscriptionResponse>
    createSubscriptionAsync(double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, boolean publishingEnabled, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)
    Create a new Subscription belonging to this client's Session.
    org.eclipse.milo.opcua.stack.core.types.structured.DeleteMonitoredItemsResponse
    deleteMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds)
    Delete one or more Monitored Items of a Subscription.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteMonitoredItemsResponse>
    deleteMonitoredItemsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds)
    Delete one or more Monitored Items of a Subscription.
    org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesResponse
    deleteNodes(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesItem> nodesToDelete)
    Delete one or more Nodes from the AddressSpace hierarchy.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesResponse>
    deleteNodesAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesItem> nodesToDelete)
    Delete one or more Nodes from the AddressSpace hierarchy.
    org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesResponse
    deleteReferences(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesItem> referencesToDelete)
    Delete one or more References from one or more Nodes.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesResponse>
    deleteReferencesAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesItem> referencesToDelete)
    Delete one or more References from one or more Nodes.
    org.eclipse.milo.opcua.stack.core.types.structured.DeleteSubscriptionsResponse
    deleteSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds)
    Delete one or more Subscriptions belonging to this client's Session.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteSubscriptionsResponse>
    deleteSubscriptionsAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds)
    Delete one or more Subscriptions belonging to this client's Session.
    OpcUaClient
    disconnect()
    Close the session, if it's open, and disconnect the underlying transport.
    CompletableFuture<OpcUaClient>
    disconnectAsync()
    Close the session, if it's open, and disconnect the underlying transport.
    AddressSpace
    getAddressSpace()
     
    OpcUaClientConfig
    getConfig()
     
    org.eclipse.milo.opcua.sdk.core.typetree.DataTypeTree
    getDataTypeTree()
    Get the DataTypeTree, reading it from the server if necessary.
    org.eclipse.milo.opcua.stack.core.types.DataTypeManager
    getDynamicDataTypeManager()
    Get the client's "dynamic" DataTypeManager.
    org.eclipse.milo.opcua.stack.core.encoding.EncodingContext
    getDynamicEncodingContext()
    Get a "dynamic" EncodingContext.
    org.eclipse.milo.opcua.stack.core.NamespaceTable
    getNamespaceTable()
    Get the local copy of the server's NamespaceTable (NamespaceArray).
    ObjectTypeManager
    getObjectTypeManager()
     
    org.eclipse.milo.opcua.sdk.core.typetree.ObjectTypeTree
    getObjectTypeTree()
    Get the ObjectTypeTree, reading it from the server if necessary.
    OperationLimits
    getOperationLimits()
    Get the local copy of the server's OperationLimits, or read them from the server if they have not been read.
    PublishingManager
    getPublishingManager()
     
    org.eclipse.milo.opcua.stack.core.ServerTable
    getServerTable()
    Get the local copy of the server's ServerTable (ServerArray).
    OpcUaSession
    getSession()
    Get the OpcUaSession, if it's available.
    CompletableFuture<OpcUaSession>
    getSessionAsync()
    Get the OpcUaSession, if it's available.
    SessionFsm
    getSessionFsm()
    Get the SessionFsm managing this client's session lifecycle.
    org.eclipse.milo.opcua.stack.core.types.DataTypeManager
    getStaticDataTypeManager()
    Get the client's "static" DataTypeManager.
    org.eclipse.milo.opcua.stack.core.encoding.EncodingContext
    getStaticEncodingContext()
    Get a "static" EncodingContext instance.
    List<OpcUaSubscription>
    getSubscriptions()
     
    org.eclipse.milo.opcua.stack.transport.client.OpcClientTransport
    getTransport()
     
    VariableTypeManager
    getVariableTypeManager()
     
    org.eclipse.milo.opcua.sdk.core.typetree.VariableTypeTree
    getVariableTypeTree()
    Get the VariableTypeTree, reading it from the server if necessary.
    org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadResponse
    historyRead(org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadDetails historyReadDetails, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadValueId> nodesToRead)
    Read historical values or Events of one or more Nodes.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadResponse>
    historyReadAsync(org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadDetails historyReadDetails, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadValueId> nodesToRead)
    Read historical values or Events of one or more Nodes.
    org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateResponse
    historyUpdate(List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateDetails> historyUpdateDetails)
    Update historical values or Events of one or more Nodes.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateResponse>
    historyUpdateAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateDetails> historyUpdateDetails)
    Update historical values or Events of one or more Nodes.
    org.eclipse.milo.opcua.stack.core.types.structured.ModifyMonitoredItemsResponse
    modifyMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemModifyRequest> itemsToModify)
    Modify Monitored Items of a Subscription.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ModifyMonitoredItemsResponse>
    modifyMonitoredItemsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemModifyRequest> itemsToModify)
    Modify Monitored Items of a Subscription.
    org.eclipse.milo.opcua.stack.core.types.structured.ModifySubscriptionResponse
    modifySubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)
    Modify an existing Subscription belonging to this client's Session.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ModifySubscriptionResponse>
    modifySubscriptionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)
    Modify an existing Subscription belonging to this client's Session.
    org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader
    newRequestHeader()
    Create a new RequestHeader with a null authentication token.
    org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader
    newRequestHeader(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId authToken)
    Create a new RequestHeader with authToken.
    org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader
    newRequestHeader(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId authToken, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestTimeout)
    Create a new RequestHeader with authToken and requestTimeout.
    org.eclipse.milo.opcua.stack.core.types.structured.PublishResponse
    publish(List<org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionAcknowledgement> subscriptionAcknowledgements)
    Send a PublishRequest to the server, acknowledging the receipt of previously-received messages and requesting the server return a NotificationMessage or keep-alive message.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.PublishResponse>
    publishAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionAcknowledgement> subscriptionAcknowledgements)
    Send a PublishRequest to the server, acknowledging the receipt of previously-received messages and requesting the server return a NotificationMessage or keep-alive message.
    org.eclipse.milo.opcua.stack.core.types.structured.QueryFirstResponse
    queryFirst(org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription view, List<org.eclipse.milo.opcua.stack.core.types.structured.NodeTypeDescription> nodeTypes, org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter filter, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxDataSetsToReturn, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxReferencesToReturn)
    Issue a query request to the server.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.QueryFirstResponse>
    queryFirstAsync(org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription view, List<org.eclipse.milo.opcua.stack.core.types.structured.NodeTypeDescription> nodeTypes, org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter filter, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxDataSetsToReturn, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxReferencesToReturn)
    Issue a query request to the server.
    org.eclipse.milo.opcua.stack.core.types.structured.QueryNextResponse
    queryNext(boolean releaseContinuationPoint, org.eclipse.milo.opcua.stack.core.types.builtin.ByteString continuationPoint)
    Request the next set of QueryFirst or QueryNext response information that was too large to be sent in a single response.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.QueryNextResponse>
    queryNextAsync(boolean releaseContinuationPoint, org.eclipse.milo.opcua.stack.core.types.builtin.ByteString continuationPoint)
    Request the next set of QueryFirst or QueryNext response information that was too large to be sent in a single response.
    org.eclipse.milo.opcua.stack.core.types.structured.ReadResponse
    read(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds)
    Read one or more attributes of one or more Nodes.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ReadResponse>
    readAsync(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds)
    Read one or more attributes of one or more Nodes.
    org.eclipse.milo.opcua.sdk.core.typetree.DataTypeTree
    readDataTypeTree()
    Read the DataTypeTree from the server and update the local copy.
    CompletionStage<org.eclipse.milo.opcua.sdk.core.typetree.DataTypeTree>
    readDataTypeTreeAsync()
    Read the DataTypeTree from the server and update the local copy.
    org.eclipse.milo.opcua.stack.core.NamespaceTable
    readNamespaceTable()
    Read the server's NamespaceTable (NamespaceArray) and update the local copy.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.NamespaceTable>
    readNamespaceTableAsync()
    Read the server's NamespaceTable (NamespaceArray) and update the local copy.
    org.eclipse.milo.opcua.sdk.core.typetree.ObjectTypeTree
    readObjectTypeTree()
    Read the ObjectTypeTree from the server and update the local copy.
    CompletionStage<org.eclipse.milo.opcua.sdk.core.typetree.ObjectTypeTree>
    readObjectTypeTreeAsync()
    Read the ObjectTypeTree from the server and update the local copy.
    OperationLimits
    readOperationLimits()
    Read the server's OperationLimits and update the local copy.
    org.eclipse.milo.opcua.stack.core.ServerTable
    readServerTable()
    Read the server's ServerTable (ServerArray) and update the local copy.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.ServerTable>
    readServerTableAsync()
    Read the server's ServerTable (ServerArray) and update the local copy.
    org.eclipse.milo.opcua.stack.core.types.builtin.DataValue
    readValue(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId)
    Read the Value attribute of a Node.
    List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue>
    readValues(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds)
    Read the Value attribute of one or more Nodes.
    CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue>>
    readValuesAsync(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds)
    Read the Value attribute of one or more Nodes.
    org.eclipse.milo.opcua.sdk.core.typetree.VariableTypeTree
    readVariableTypeTree()
    Read the VariableTypeTree from the server and update the local copy.
    CompletionStage<org.eclipse.milo.opcua.sdk.core.typetree.VariableTypeTree>
    readVariableTypeTreeAsync()
    Read the VariableTypeTree from the server and update the local copy.
    org.eclipse.milo.opcua.stack.core.types.structured.RegisterNodesResponse
    registerNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToRegister)
    Register NodeIds that the client intends to access repeatedly (e.g. read, write, call), allowing servers to set up anything needed so that the access operations are more efficient.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.RegisterNodesResponse>
    registerNodesAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToRegister)
    Register Nodes that the client intends to access repeatedly (e.g. read, write, call), allowing servers to set up anything needed so that the access operations are more efficient.
    void
    removeFaultListener(ServiceFaultListener faultListener)
     
    void
    removeSessionActivityListener(SessionActivityListener listener)
     
    void
    removeSessionInitializer(SessionFsm.SessionInitializer initializer)
     
    void
    removeSubscription(OpcUaSubscription subscription)
     
    org.eclipse.milo.opcua.stack.core.types.structured.RepublishResponse
    republish(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger retransmitSequenceNumber)
    Send a RepublishRequest to the server, requesting the server republish a NotificationMessage from its retransmission queue.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.RepublishResponse>
    republishAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger retransmitSequenceNumber)
    Send a RepublishRequest to the server, requesting the server republish a NotificationMessage from its retransmission queue.
    org.eclipse.milo.opcua.stack.core.types.UaResponseMessageType
    sendRequest(org.eclipse.milo.opcua.stack.core.types.UaRequestMessageType request)
    Send a service request and wait for the service response.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.UaResponseMessageType>
    sendRequestAsync(org.eclipse.milo.opcua.stack.core.types.UaRequestMessageType request)
    Send a service request asynchronously.
    void
    setDataTypeTreeFactory(DataTypeTreeFactory dataTypeTreeFactory)
    Set the DataTypeTreeFactory used to create the DataTypeTree.
    void
    setDynamicDataTypeManagerFactory(DataTypeManagerFactory dynamicDataTypeManagerFactory)
    Set the DataTypeManagerFactory used to create the dynamic DataTypeManager.
    org.eclipse.milo.opcua.stack.core.types.structured.SetMonitoringModeResponse
    setMonitoringMode(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds)
    Set the Monitoring Mode for one or more Monitored Items of a Subscription.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetMonitoringModeResponse>
    setMonitoringModeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds)
    Set the Monitoring Mode for one or more Monitored Items of a Subscription.
    org.eclipse.milo.opcua.stack.core.types.structured.SetPublishingModeResponse
    setPublishingMode(boolean publishingEnabled, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds)
    Enable or disable the sending of notifications on one or more subscriptions.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetPublishingModeResponse>
    setPublishingModeAsync(boolean publishingEnabled, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds)
    Enable or disable the sending of notifications on one or more subscriptions.
    org.eclipse.milo.opcua.stack.core.types.structured.SetTriggeringResponse
    setTriggering(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger triggeringItemId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToAdd, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToRemove)
    Create and delete triggering links for a triggering item.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetTriggeringResponse>
    setTriggeringAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger triggeringItemId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToAdd, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToRemove)
    Create and delete triggering links for a triggering item.
    org.eclipse.milo.opcua.stack.core.types.structured.TransferSubscriptionsResponse
    transferSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds, boolean sendInitialValues)
    Transfer a Subscription and its MonitoredItems from one Session to another (this) Session.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TransferSubscriptionsResponse>
    transferSubscriptionsAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds, boolean sendInitialValues)
    Transfer a Subscription and its MonitoredItems from one Session to another (this) Session.
    org.eclipse.milo.opcua.stack.core.types.structured.TranslateBrowsePathsToNodeIdsResponse
    translateBrowsePaths(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowsePath> browsePaths)
    Translate one or more BrowsePaths into NodeIds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TranslateBrowsePathsToNodeIdsResponse>
    translateBrowsePathsAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowsePath> browsePaths)
    Translate one or more BrowsePaths into NodeIds.
    org.eclipse.milo.opcua.stack.core.types.structured.UnregisterNodesResponse
    unregisterNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToUnregister)
    Unregister Nodes that were previously registered with a Register Nodes service call.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.UnregisterNodesResponse>
    unregisterNodesAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToUnregister)
    Unregister Nodes that were previously registered with a Register Nodes service call.
    org.eclipse.milo.opcua.stack.core.types.structured.WriteResponse
    write(List<org.eclipse.milo.opcua.stack.core.types.structured.WriteValue> writeValues)
    Write attribute values to one or more Nodes.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.WriteResponse>
    writeAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.WriteValue> writeValues)
    Write attribute values to one or more Nodes.
    List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeValues(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> values)
    Write the Value attribute of one or more Nodes.
    CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>>
    writeValuesAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> values)
    Write the Value attribute of one or more Nodes.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • SDK_VERSION

      public static final String SDK_VERSION

  • Constructor Details

    • OpcUaClient

      public OpcUaClient(OpcUaClientConfig config, org.eclipse.milo.opcua.stack.transport.client.OpcClientTransport transport)

  • Method Details

    • create

      public static OpcUaClient create(OpcUaClientConfig config) throws org.eclipse.milo.opcua.stack.core.UaException
      Create an OpcUaClient configured with config.
      Parameters:
      config - the OpcUaClientConfig.
      Returns:
      a new OpcUaClient configured with config.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if the client could not be created.

    • create

      public static OpcUaClient create(OpcUaClientConfig config, Consumer<org.eclipse.milo.opcua.stack.transport.client.tcp.OpcTcpClientTransportConfigBuilder> configureTransport) throws org.eclipse.milo.opcua.stack.core.UaException
      Create an OpcUaClient configured with config.
      Parameters:
      config - the OpcUaClientConfig.
      configureTransport - a Consumer that receives an OpcTcpClientTransportConfigBuilder that can be used to configure the transport.
      Returns:
      a new OpcUaClient configured with config.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if the client could not be created.

    • create

      public static OpcUaClient create(String endpointUrl) throws org.eclipse.milo.opcua.stack.core.UaException
      Select the first endpoint with no security that allows anonymous connections and create an OpcUaClient with the default configuration.

      If the server is not configured with an endpoint with no security or authentication you must use create(String, Function, Consumer, Consumer) to select an endpoint and configure any certificates or identity provider that the selected endpoint would require.

      Parameters:
      endpointUrl - the endpoint URL of the server to connect to and get endpoints from.
      Returns:
      an OpcUaClient configured to connect to the server identified by endpointUrl.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if the endpoints could not be retrieved or the client could not be created.

    • create

      public static OpcUaClient create(String endpointUrl, Function<List<org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription>,Optional<org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription>> selectEndpoint, Consumer<org.eclipse.milo.opcua.stack.transport.client.tcp.OpcTcpClientTransportConfigBuilder> configureTransport, Consumer<OpcUaClientConfigBuilder> configureClient) throws org.eclipse.milo.opcua.stack.core.UaException
      Create and configure an OpcUaClient by selecting an EndpointDescription from a list of endpoints retrieved via the GetEndpoints service from the server at endpointUrl and building an OpcUaClientConfig using that endpoint.
      Parameters:
      endpointUrl - the endpoint URL of the server to connect to and retrieve endpoints from.
      selectEndpoint - a function that selects the EndpointDescription to connect to from the list of endpoints from the server.
      configureTransport - a Consumer that receives an OpcTcpClientTransportConfigBuilder that can be used to configure the transport.
      configureClient - a Consumer that receives an OpcUaClientConfigBuilder that can be used to configure the client.
      Returns:
      a configured OpcUaClient.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if the endpoints could not be retrieved or the client could not be created.

    • connect

      public OpcUaClient connect() throws org.eclipse.milo.opcua.stack.core.UaException
      Connect the underlying transport and open a session.

      Regardless of the success or failure of the initial connect operation, the client is now in a state where it will strive to remain connected and keep a session open, automatically reconnecting as necessary, and creating or transferring sessions as necessary.

      Returns:
      this OpcUaClient
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs.

    • connectAsync

      public CompletableFuture<OpcUaClient> connectAsync()
      Connect the underlying transport and open a session.

      Regardless of the success or failure of the initial connect operation, the client is now in a state where it will strive to remain connected and keep a session open, automatically reconnecting as necessary, and creating or transferring sessions as necessary.

      Returns:
      a CompletableFuture that completes successfully with this OpcUaClient, or completes exceptionally if an error occurs.

    • disconnect

      public OpcUaClient disconnect() throws org.eclipse.milo.opcua.stack.core.UaException
      Close the session, if it's open, and disconnect the underlying transport.
      Returns:
      this OpcUaClient.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an unexpected error occurs. Errors closing the session or the disconnecting the transport are swallowed.

    • disconnectAsync

      public CompletableFuture<OpcUaClient> disconnectAsync()
      Close the session, if it's open, and disconnect the underlying transport.
      Returns:
      a CompletableFuture that completes successfully with this OpcUaClient, or completes exceptionally if an unexpected error occurs. Errors closing the session or the disconnecting the transport are swallowed.

    • getSession

      public OpcUaSession getSession() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the OpcUaSession, if it's available.
      Returns:
      the OpcUaSession.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs getting the session.

    • getSessionAsync

      public CompletableFuture<OpcUaSession> getSessionAsync()
      Get the OpcUaSession, if it's available.
      Returns:
      a CompletableFuture that completes successfully with the OpcUaSession, or completes exceptionally if an error occurs getting the session.

    • getSessionFsm

      public SessionFsm getSessionFsm()
      Get the SessionFsm managing this client's session lifecycle.
      Returns:
      the SessionFsm for this client.

    • getConfig

      public OpcUaClientConfig getConfig()

    • getTransport

      public org.eclipse.milo.opcua.stack.transport.client.OpcClientTransport getTransport()

    • getAddressSpace

      public AddressSpace getAddressSpace()

    • getObjectTypeManager

      public ObjectTypeManager getObjectTypeManager()

    • getVariableTypeManager

      public VariableTypeManager getVariableTypeManager()

    • addSubscription

      public void addSubscription(OpcUaSubscription subscription)

    • removeSubscription

      public void removeSubscription(OpcUaSubscription subscription)

    • getSubscriptions

      public List<OpcUaSubscription> getSubscriptions()

    • getPublishingManager

      public PublishingManager getPublishingManager()

    • getStaticDataTypeManager

      public org.eclipse.milo.opcua.stack.core.types.DataTypeManager getStaticDataTypeManager()
      Get the client's "static" DataTypeManager.

      This DataTypeManager is for static codecs that serialize classes that exist at compile time, e.g. structures from namespace 0 and or code-generated structures.

      Returns:
      the client's static DataTypeManager.

    • getDynamicDataTypeManager

      public org.eclipse.milo.opcua.stack.core.types.DataTypeManager getDynamicDataTypeManager() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the client's "dynamic" DataTypeManager.

      This DataTypeManager is for dynamic codecs created by reading datatype information from the server at runtime.

      By default, the client uses DataTypeManagerFactory.eager(), which creates a DefaultDataTypeManager with all known types eagerly registered.

      Use setDynamicDataTypeManagerFactory(DataTypeManagerFactory) with DataTypeManagerFactory.lazy() to configure the client with a LazyClientDataTypeManager that resolves codecs on demand.

      Returns:
      the client's dynamic DataTypeManager.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException
      See Also:

    • getStaticEncodingContext

      public org.eclipse.milo.opcua.stack.core.encoding.EncodingContext getStaticEncodingContext()
      Get a "static" EncodingContext instance.

      This EncodingContext instance returns the client's static DataTypeManager.

      Returns:
      a "static" EncodingContext instance.
      See Also:

    • getDynamicEncodingContext

      public org.eclipse.milo.opcua.stack.core.encoding.EncodingContext getDynamicEncodingContext() throws org.eclipse.milo.opcua.stack.core.UaException
      Get a "dynamic" EncodingContext.

      This EncodingContext instance returns the client's dynamic DataTypeManager.

      Returns:
      a "dynamic" EncodingContext.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException
      See Also:

    • getNamespaceTable

      public org.eclipse.milo.opcua.stack.core.NamespaceTable getNamespaceTable()
      Get the local copy of the server's NamespaceTable (NamespaceArray).
      Returns:
      the local copy of the server's NamespaceTable (NamespaceArray).

    • readNamespaceTable

      public org.eclipse.milo.opcua.stack.core.NamespaceTable readNamespaceTable() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the server's NamespaceTable (NamespaceArray) and update the local copy.
      Returns:
      the updated NamespaceTable.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an operation- or service-level error occurs.

    • readNamespaceTableAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.NamespaceTable> readNamespaceTableAsync()
      Read the server's NamespaceTable (NamespaceArray) and update the local copy.

      This call completes asynchronously.

      Returns:
      a CompletableFuture that completes successfully with the updated NamespaceTable or completes exceptionally if a service- or operation-level error occurs.

    • getServerTable

      public org.eclipse.milo.opcua.stack.core.ServerTable getServerTable()
      Get the local copy of the server's ServerTable (ServerArray).
      Returns:
      the local copy of the server's ServerTable (ServerArray).

    • readServerTable

      public org.eclipse.milo.opcua.stack.core.ServerTable readServerTable() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the server's ServerTable (ServerArray) and update the local copy.
      Returns:
      the updated ServerTable.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an operation- or service-level error occurs.

    • readServerTableAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.ServerTable> readServerTableAsync()
      Read the server's ServerTable (ServerArray) and update the local copy.

      This call completes asynchronously.

      Returns:
      a CompletableFuture that completes successfully with the updated ServerTable or completes exceptionally if a service- or operation-level error occurs.

    • getDataTypeTree

      public org.eclipse.milo.opcua.sdk.core.typetree.DataTypeTree getDataTypeTree() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the DataTypeTree, reading it from the server if necessary.
      Returns:
      the DataTypeTree.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs while reading the DataTypes.

    • readDataTypeTree

      public org.eclipse.milo.opcua.sdk.core.typetree.DataTypeTree readDataTypeTree() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the DataTypeTree from the server and update the local copy.
      Returns:
      the updated DataTypeTree.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs while reading the DataTypes.

    • readDataTypeTreeAsync

      public CompletionStage<org.eclipse.milo.opcua.sdk.core.typetree.DataTypeTree> readDataTypeTreeAsync()
      Read the DataTypeTree from the server and update the local copy.
      Returns:
      a CompletionStage that completes successfully with the updated DataTypeTree, or completes exceptionally if an error occurs while reading the DataTypes.

    • getObjectTypeTree

      public org.eclipse.milo.opcua.sdk.core.typetree.ObjectTypeTree getObjectTypeTree() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the ObjectTypeTree, reading it from the server if necessary.
      Returns:
      the ObjectTypeTree.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs while reading the ObjectTypes.

    • readObjectTypeTree

      public org.eclipse.milo.opcua.sdk.core.typetree.ObjectTypeTree readObjectTypeTree() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the ObjectTypeTree from the server and update the local copy.
      Returns:
      the updated ObjectTypeTree.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs while reading the ObjectTypes.

    • readObjectTypeTreeAsync

      public CompletionStage<org.eclipse.milo.opcua.sdk.core.typetree.ObjectTypeTree> readObjectTypeTreeAsync()
      Read the ObjectTypeTree from the server and update the local copy.
      Returns:
      a CompletionStage that completes successfully with the updated ObjectTypeTree, or completes exceptionally if an error occurs while reading the ObjectTypes.

    • getVariableTypeTree

      public org.eclipse.milo.opcua.sdk.core.typetree.VariableTypeTree getVariableTypeTree() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the VariableTypeTree, reading it from the server if necessary.
      Returns:
      the VariableTypeTree.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs while reading the VariableTypes.

    • readVariableTypeTree

      public org.eclipse.milo.opcua.sdk.core.typetree.VariableTypeTree readVariableTypeTree() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the VariableTypeTree from the server and update the local copy.
      Returns:
      the updated VariableTypeTree.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs while reading the VariableTypes.

    • readVariableTypeTreeAsync

      public CompletionStage<org.eclipse.milo.opcua.sdk.core.typetree.VariableTypeTree> readVariableTypeTreeAsync()
      Read the VariableTypeTree from the server and update the local copy.
      Returns:
      a CompletionStage that completes successfully with the updated VariableTypeTree, or completes exceptionally if an error occurs while reading the VariableTypes.

    • getOperationLimits

      public OperationLimits getOperationLimits() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local copy of the server's OperationLimits, or read them from the server if they have not been read.
      Returns:
      the server's OperationLimits.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs reading the operation limits.

    • readOperationLimits

      public OperationLimits readOperationLimits() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the server's OperationLimits and update the local copy.
      Returns:
      the server's OperationLimits.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs reading the operation limits.

    • newRequestHeader

      public org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader newRequestHeader()
      Create a new RequestHeader with a null authentication token.

      A unique request handle will be automatically assigned to the header.

      Returns:
      a new RequestHeader with a null authentication token.

    • newRequestHeader

      public org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader newRequestHeader(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId authToken)
      Create a new RequestHeader with authToken.

      A unique request handle will be automatically assigned to the header.

      Parameters:
      authToken - the authentication token to create the header with.
      Returns:
      a new RequestHeader created with authToken.

    • newRequestHeader

      public org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader newRequestHeader(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId authToken, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestTimeout)
      Create a new RequestHeader with authToken and requestTimeout.

      A unique request handle will be automatically assigned to the header.

      Parameters:
      authToken - the authentication token to create the header with.
      requestTimeout - the timeout hint to create the header with.
      Returns:
      a new RequestHeader created with authToken and requestTimeout.

    • setDataTypeTreeFactory

      public void setDataTypeTreeFactory(DataTypeTreeFactory dataTypeTreeFactory)
      Set the DataTypeTreeFactory used to create the DataTypeTree.

      By default, the client uses DataTypeTreeFactory.eager(), which eagerly builds the complete DataTypeTree using DataTypeTreeBuilder.build(OpcUaClient).

      Use DataTypeTreeFactory.lazy() to configure the client with a lazy-loading tree that resolves types on demand. This can be more efficient when only a subset of types is needed or when the server doesn't support recursive forward browsing of the DataType hierarchy.

      This resets the client's cached DataTypeTree. It will be built or rebuilt the next time it is accessed.

      Parameters:
      dataTypeTreeFactory - the DataTypeTreeFactory to set.
      See Also:

    • setDynamicDataTypeManagerFactory

      public void setDynamicDataTypeManagerFactory(DataTypeManagerFactory dynamicDataTypeManagerFactory)
      Set the DataTypeManagerFactory used to create the dynamic DataTypeManager.

      By default, the client uses DataTypeManagerFactory.eager(), which creates a DefaultDataTypeManager with all known types eagerly registered.

      Use DataTypeManagerFactory.lazy() to configure the client with a LazyClientDataTypeManager that resolves codecs on demand. This pairs well with DataTypeTreeFactory.lazy() for a fully lazy type resolution system.

      This resets the client's cached DataTypeManager. It will be created again the next time it is accessed.

      Parameters:
      dynamicDataTypeManagerFactory - the DataTypeManagerFactory to set.
      See Also:

    • read

      public org.eclipse.milo.opcua.stack.core.types.structured.ReadResponse read(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds) throws org.eclipse.milo.opcua.stack.core.UaException
      Read one or more attributes of one or more Nodes.
      Parameters:
      maxAge - the requested max age of the value, in milliseconds. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.
      timestampsToReturn - the requested TimestampsToReturn.
      readValueIds - the ReadValueIds identifying the nodes and attributes to read.
      Returns:
      the ReadResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs.
      See Also:

    • readValue

      public org.eclipse.milo.opcua.stack.core.types.builtin.DataValue readValue(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId) throws org.eclipse.milo.opcua.stack.core.UaException
      Read the Value attribute of a Node.
      Parameters:
      maxAge - the requested max age of the value, in milliseconds. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.
      timestampsToReturn - the requested TimestampsToReturn.
      nodeId - the NodeIds identifying the Node to read.
      Returns:
      the DataValue.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs.
      See Also:

    • readValues

      public List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> readValues(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds) throws org.eclipse.milo.opcua.stack.core.UaException
      Read the Value attribute of one or more Nodes.
      Parameters:
      maxAge - the requested max age of the value, in milliseconds. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.
      timestampsToReturn - the requested TimestampsToReturn.
      nodeIds - the NodeIds identifying the Nodes to read.
      Returns:
      a List of DataValues.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs.
      See Also:

    • readAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ReadResponse> readAsync(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId> readValueIds)
      Read one or more attributes of one or more Nodes.
      Parameters:
      maxAge - the requested max age of the value, in milliseconds. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.
      timestampsToReturn - the requested TimestampsToReturn.
      readValueIds - the ReadValueIds identifying the nodes and attributes to read.
      Returns:
      a CompletableFuture that completes successfully with the ReadResponse, or completes exceptionally if an error occurs.
      See Also:

    • readValuesAsync

      public CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue>> readValuesAsync(double maxAge, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds)
      Read the Value attribute of one or more Nodes.
      Parameters:
      maxAge - the requested max age of the value, in milliseconds. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.
      timestampsToReturn - the requested TimestampsToReturn.
      nodeIds - the NodeIds identifying the Nodes to read.
      Returns:
      a CompletableFuture that completes successfully with a list of DataValues, or completes exceptionally if an error occurs.
      See Also:

    • write

      public org.eclipse.milo.opcua.stack.core.types.structured.WriteResponse write(List<org.eclipse.milo.opcua.stack.core.types.structured.WriteValue> writeValues) throws org.eclipse.milo.opcua.stack.core.UaException
      Write attribute values to one or more Nodes.
      Parameters:
      writeValues - a List of WriteValues describing the Nodes and attribute values to write.
      Returns:
      the WriteResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • writeValues

      public List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeValues(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> values) throws org.eclipse.milo.opcua.stack.core.UaException
      Write the Value attribute of one or more Nodes.
      Parameters:
      nodeIds - the NodeIds identifying the Nodes to write.
      values - the DataValues to write.
      Returns:
      a List of StatusCodes describing the result of each write operation.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • writeAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.WriteResponse> writeAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.WriteValue> writeValues)
      Write attribute values to one or more Nodes.
      Parameters:
      writeValues - a List of WriteValues describing the Nodes and attribute values to write
      Returns:
      a CompletableFuture that completes successfully with the WriteResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • writeValuesAsync

      public CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>> writeValuesAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodeIds, List<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> values)
      Write the Value attribute of one or more Nodes.
      Parameters:
      nodeIds - the NodeIds identifying the Nodes to write.
      values - the DataValues to write.
      Returns:
      a CompletableFuture that completes successfully with a List of StatusCodes describing the result of each write operation, or completes exceptionally if there is an error invoking the service.
      See Also:

    • historyRead

      public org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadResponse historyRead(org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadDetails historyReadDetails, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadValueId> nodesToRead) throws org.eclipse.milo.opcua.stack.core.UaException
      Read historical values or Events of one or more Nodes.
      Parameters:
      historyReadDetails - defines the types of history read to be performed.
      timestampsToReturn - specifies the timestamps to be returned for each requested value attribute.
      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 historical information.
      nodesToRead - the list of items upon which the historical retrieval is to be performed.
      Returns:
      the HistoryReadResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • historyReadAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadResponse> historyReadAsync(org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadDetails historyReadDetails, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryReadValueId> nodesToRead)
      Read historical values or Events of one or more Nodes.
      Parameters:
      historyReadDetails - defines the types of history read to be performed.
      timestampsToReturn - specifies the timestamps to be returned for each requested value attribute.
      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 historical information.
      nodesToRead - the list of items upon which the historical retrieval is to be performed.
      Returns:
      a CompletableFuture that completes successfully with the HistoryReadResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • historyUpdate

      public org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateResponse historyUpdate(List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateDetails> historyUpdateDetails) throws org.eclipse.milo.opcua.stack.core.UaException
      Update historical values or Events of one or more Nodes.
      Parameters:
      historyUpdateDetails - the HistoryUpdateDetails for this update.
      Returns:
      the HistoryUpdateResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • historyUpdateAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateResponse> historyUpdateAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateDetails> historyUpdateDetails)
      Update historical values or Events of one or more Nodes.
      Parameters:
      historyUpdateDetails - the HistoryUpdateDetails for this update.
      Returns:
      a CompletableFuture that completes successfully with the HistoryUpdateResponse, or completes exceptionally if there is an error invoking the service.

    • call

      public org.eclipse.milo.opcua.stack.core.types.structured.CallResponse call(List<org.eclipse.milo.opcua.stack.core.types.structured.CallMethodRequest> requests) throws org.eclipse.milo.opcua.stack.core.UaException
      Call (invoke) one or more methods.
      Parameters:
      requests - the CallMethodRequests identifying the object/method to call and the input arguments.
      Returns:
      the CallResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs.
      See Also:

    • callAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CallResponse> callAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.CallMethodRequest> requests)
      Call (invoke) one or more methods.
      Parameters:
      requests - the CallMethodRequests identifying the object/method to call and the input arguments.
      Returns:
      a CompletableFuture that completes successfully with the CallResponse, or completes exceptionally if an error occurs.
      See Also:

    • createMonitoredItems

      public org.eclipse.milo.opcua.stack.core.types.structured.CreateMonitoredItemsResponse createMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest> itemsToCreate) throws org.eclipse.milo.opcua.stack.core.UaException
      Create and add one or more Monitored Items to a Subscription.
      Parameters:
      subscriptionId - the server-assigned identifier for the subscription that will report notifications for the Monitored Items.
      timestampsToReturn - the TimestampsToReturn.
      itemsToCreate - a List of MonitoredItemCreateRequest that describe the Monitored Items to be created and assigned to the specified subscription.
      Returns:
      the CreateMonitoredItemsResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • createMonitoredItemsAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CreateMonitoredItemsResponse> createMonitoredItemsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemCreateRequest> itemsToCreate)
      Create and add one or more Monitored Items to a Subscription.
      Parameters:
      subscriptionId - the server-assigned identifier for the subscription that will report notifications for the Monitored Items.
      timestampsToReturn - the TimestampsToReturn.
      itemsToCreate - a List of MonitoredItemCreateRequest that describe the Monitored Items to be created and assigned to the specified subscription.
      Returns:
      a CompletableFuture that completes successfully with the CreateMonitoredItemsResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • modifyMonitoredItems

      public org.eclipse.milo.opcua.stack.core.types.structured.ModifyMonitoredItemsResponse modifyMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemModifyRequest> itemsToModify) throws org.eclipse.milo.opcua.stack.core.UaException
      Modify Monitored Items of a Subscription.
      Parameters:
      subscriptionId - the server-assigned identifier for the subscription that owns the items to modify.
      timestampsToReturn - the TimestampsToReturn.
      itemsToModify - a List of MonitoredItemModifyRequest that describe Monitored Items to modify.
      Returns:
      the ModifyMonitoredItemsResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • modifyMonitoredItemsAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ModifyMonitoredItemsResponse> modifyMonitoredItemsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestampsToReturn, List<org.eclipse.milo.opcua.stack.core.types.structured.MonitoredItemModifyRequest> itemsToModify)
      Modify Monitored Items of a Subscription.
      Parameters:
      subscriptionId - the server-assigned identifier for the subscription that owns the items to modify.
      timestampsToReturn - the TimestampsToReturn.
      itemsToModify - a List of MonitoredItemModifyRequest that describe Monitored Items to modify.
      Returns:
      a CompletableFuture that completes successfully with the ModifyMonitoredItemsResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • deleteMonitoredItems

      public org.eclipse.milo.opcua.stack.core.types.structured.DeleteMonitoredItemsResponse deleteMonitoredItems(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds) throws org.eclipse.milo.opcua.stack.core.UaException
      Delete one or more Monitored Items of a Subscription.
      Parameters:
      subscriptionId - the server-assigned identifier for the subscription that owns the Monitored Items to delete.
      monitoredItemIds - a List of server-assigned identifiers for the Monitored Items to delete.
      Returns:
      the DeleteMonitoredItemsResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • deleteMonitoredItemsAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteMonitoredItemsResponse> deleteMonitoredItemsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds)
      Delete one or more Monitored Items of a Subscription.
      Parameters:
      subscriptionId - the server-assigned identifier for the subscription that owns the Monitored Items to delete.
      monitoredItemIds - a List of server-assigned identifiers for the Monitored Items to delete.
      Returns:
      a CompletableFuture that completes successfully with the DeleteMonitoredItemsResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • setMonitoringMode

      public org.eclipse.milo.opcua.stack.core.types.structured.SetMonitoringModeResponse setMonitoringMode(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the Monitoring Mode for one or more Monitored Items of a Subscription.
      Parameters:
      subscriptionId - the server-assigned identifier for the subscription that owns the Monitored Items.
      monitoringMode - the MonitoringMode to be set for the Monitored Items.
      monitoredItemIds - a List of server-assigned identifiers for the Monitored Items that will have their MonitoringMode set.
      Returns:
      the SetMonitoringModeResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • setMonitoringModeAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetMonitoringModeResponse> setMonitoringModeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> monitoredItemIds)
      Set the Monitoring Mode for one or more Monitored Items of a Subscription.
      Parameters:
      subscriptionId - the server-assigned identifier for the subscription that owns the Monitored Items.
      monitoringMode - the MonitoringMode to be set for the Monitored Items.
      monitoredItemIds - a List of server-assigned identifiers for the Monitored Items that will have their MonitoringMode set.
      Returns:
      a CompletableFuture that completes successfully with the SetMonitoringModeResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • setTriggering

      public org.eclipse.milo.opcua.stack.core.types.structured.SetTriggeringResponse setTriggering(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger triggeringItemId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToAdd, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToRemove) throws org.eclipse.milo.opcua.stack.core.UaException
      Create and delete triggering links for a triggering item.
      Parameters:
      subscriptionId - the server-assigned identifier for the subscription that owns the triggering item and items to report.
      triggeringItemId - the server-assigned identifier for the Monitored Item to use as the triggering item.
      linksToAdd - a List of server-assigned identifiers for the Monitored Items that are to be added as triggering links.
      linksToRemove - a List of server-assigned identifiers for the Monitored Items that are to be removed as triggering links.
      Returns:
      the SetTriggeringResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • setTriggeringAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetTriggeringResponse> setTriggeringAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger triggeringItemId, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToAdd, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> linksToRemove)
      Create and delete triggering links for a triggering item.
      Parameters:
      subscriptionId - the server-assigned identifier for the subscription that owns the triggering item and items to report.
      triggeringItemId - the server-assigned identifier for the Monitored Item to use as the triggering item.
      linksToAdd - a List of server-assigned identifiers for the Monitored Items that are to be added as triggering links.
      linksToRemove - a List of server-assigned identifiers for the Monitored Items that are to be removed as triggering links.
      Returns:
      a CompletableFuture that completes successfully with the SetTriggeringResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • addNodes

      public org.eclipse.milo.opcua.stack.core.types.structured.AddNodesResponse addNodes(List<org.eclipse.milo.opcua.stack.core.types.structured.AddNodesItem> nodesToAdd) throws org.eclipse.milo.opcua.stack.core.UaException
      Add one or more Nodes to the AddressSpace hierarchy.
      Parameters:
      nodesToAdd - a List of AddNodesItem describing the Nodes to be added.
      Returns:
      the AddNodesResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • addNodesAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.AddNodesResponse> addNodesAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.AddNodesItem> nodesToAdd)
      Add one or more Nodes to the AddressSpace hierarchy.
      Parameters:
      nodesToAdd - a List of AddNodesItem describing the Nodes to be added.
      Returns:
      a CompletableFuture that completes successfully with the AddNodesResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • addReferences

      public org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesResponse addReferences(List<org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesItem> referencesToAdd) throws org.eclipse.milo.opcua.stack.core.UaException
      Add one or more References to one or more Nodes.
      Parameters:
      referencesToAdd - a List of AddReferencesItems describing the References to add.
      Returns:
      the AddReferencesResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • addReferencesAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesResponse> addReferencesAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesItem> referencesToAdd)
      Add one or more References to one or more Nodes.
      Parameters:
      referencesToAdd - a List of AddReferencesItems describing the References to add.
      Returns:
      a CompletableFuture that completes successfully with the AddReferencesResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • deleteNodes

      public org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesResponse deleteNodes(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesItem> nodesToDelete) throws org.eclipse.milo.opcua.stack.core.UaException
      Delete one or more Nodes from the AddressSpace hierarchy.
      Parameters:
      nodesToDelete - a List of DeleteNodesItems describing the Nodes to delete.
      Returns:
      the DeleteNodesResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • deleteNodesAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesResponse> deleteNodesAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesItem> nodesToDelete)
      Delete one or more Nodes from the AddressSpace hierarchy.
      Parameters:
      nodesToDelete - a List of DeleteNodesItems describing the Nodes to delete.
      Returns:
      a CompletableFuture that completes successfully with the DeleteNodesResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • deleteReferences

      public org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesResponse deleteReferences(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesItem> referencesToDelete) throws org.eclipse.milo.opcua.stack.core.UaException
      Delete one or more References from one or more Nodes.
      Parameters:
      referencesToDelete - a List of DeleteReferencesItem describing the References to delete.
      Returns:
      the DeleteReferencesResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • deleteReferencesAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesResponse> deleteReferencesAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesItem> referencesToDelete)
      Delete one or more References from one or more Nodes.
      Parameters:
      referencesToDelete - a List of DeleteReferencesItem describing the References to delete.
      Returns:
      a CompletableFuture that completes successfully with the DeleteReferencesResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • queryFirst

      public org.eclipse.milo.opcua.stack.core.types.structured.QueryFirstResponse queryFirst(org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription view, List<org.eclipse.milo.opcua.stack.core.types.structured.NodeTypeDescription> nodeTypes, org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter filter, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxDataSetsToReturn, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxReferencesToReturn) throws org.eclipse.milo.opcua.stack.core.UaException
      Issue a query request to the server.
      Parameters:
      view - specifies a View and temporal context to a server.
      nodeTypes - a List of NodeTypeDescription that describe that type of Nodes to search for.
      filter - a ContentFilter that limits the resulting Nodes to those matching the filter criteria.
      maxDataSetsToReturn - the maximum number of QueryDataSets to return.
      maxReferencesToReturn - the maximum number of References to return for each QueryDataSet.
      Returns:
      the QueryFirstResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • queryFirstAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.QueryFirstResponse> queryFirstAsync(org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription view, List<org.eclipse.milo.opcua.stack.core.types.structured.NodeTypeDescription> nodeTypes, org.eclipse.milo.opcua.stack.core.types.structured.ContentFilter filter, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxDataSetsToReturn, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxReferencesToReturn)
      Issue a query request to the server.
      Parameters:
      view - specifies a View and temporal context to a server.
      nodeTypes - a List of NodeTypeDescription that describe that type of Nodes to search for.
      filter - a ContentFilter that limits the resulting Nodes to those matching the filter criteria.
      maxDataSetsToReturn - the maximum number of QueryDataSets to return.
      maxReferencesToReturn - the maximum number of References to return for each QueryDataSet.
      Returns:
      a CompletableFuture that completes successfully with the QueryFirstResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • queryNext

      public org.eclipse.milo.opcua.stack.core.types.structured.QueryNextResponse queryNext(boolean releaseContinuationPoint, org.eclipse.milo.opcua.stack.core.types.builtin.ByteString continuationPoint) throws org.eclipse.milo.opcua.stack.core.UaException
      Request the next set of QueryFirst or QueryNext response information that was too large to be sent in a single response.
      Parameters:
      releaseContinuationPoint - if true, passed continuation points shall be reset to free resources in the server. If false, passed continuation Points shall be used to get the next set of browse information.
      continuationPoint - a server-defined opaque value that represents the continuation point.
      Returns:
      the QueryNextResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • queryNextAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.QueryNextResponse> queryNextAsync(boolean releaseContinuationPoint, org.eclipse.milo.opcua.stack.core.types.builtin.ByteString continuationPoint)
      Request the next set of QueryFirst or QueryNext response information that was too large to be sent in a single response.
      Parameters:
      releaseContinuationPoint - if true, passed continuation points shall be reset to free resources in the server. If false, passed continuation Points shall be used to get the next set of browse information.
      continuationPoint - a server-defined opaque value that represents the continuation point.
      Returns:
      a CompletableFuture that completes successfully with the QueryNextResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • createSubscription

      public org.eclipse.milo.opcua.stack.core.types.structured.CreateSubscriptionResponse createSubscription(double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, boolean publishingEnabled, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority) throws org.eclipse.milo.opcua.stack.core.UaException
      Create a new Subscription belonging to this client's Session.
      Parameters:
      requestedPublishingInterval - this interval defines the cyclic rate that the subscription is being requested to return notifications to the client. This interval is expressed in milliseconds.
      requestedLifetimeCount - the requested lifetime count. The lifetime count shall be a minimum of three times the keep keep-alive count.
      requestedMaxKeepAliveCount - the requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any notification to be sent, the subscription sends a keep-alive message to the client.
      maxNotificationsPerPublish - the maximum number of notifications that the client wishes to receive in a single publish response. A value of zero indicates that there is no limit.
      publishingEnabled - if true, publishing is enabled for this subscription.
      priority - indicates the relative priority of the subscription.
      Returns:
      the CreateSubscriptionResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • createSubscriptionAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CreateSubscriptionResponse> createSubscriptionAsync(double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, boolean publishingEnabled, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)
      Create a new Subscription belonging to this client's Session.
      Parameters:
      requestedPublishingInterval - this interval defines the cyclic rate that the subscription is being requested to return notifications to the client. This interval is expressed in milliseconds.
      requestedLifetimeCount - the requested lifetime count. The lifetime count shall be a minimum of three times the keep keep-alive count.
      requestedMaxKeepAliveCount - the requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any notification to be sent, the subscription sends a keep-alive message to the client.
      maxNotificationsPerPublish - the maximum number of notifications that the client wishes to receive in a single publish response. A value of zero indicates that there is no limit.
      publishingEnabled - if true, publishing is enabled for this subscription.
      priority - indicates the relative priority of the subscription.
      Returns:
      a CompletableFuture that completes successfully with the CreateSubscriptionResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • modifySubscription

      public org.eclipse.milo.opcua.stack.core.types.structured.ModifySubscriptionResponse modifySubscription(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority) throws org.eclipse.milo.opcua.stack.core.UaException
      Modify an existing Subscription belonging to this client's Session.
      Parameters:
      subscriptionId - the server-assigned identifier for the Subscription.
      requestedPublishingInterval - this interval defines the cyclic rate that the subscription is being requested to return notifications to the client. This interval is expressed in milliseconds.
      requestedLifetimeCount - the requested lifetime count. The lifetime count shall be a minimum of three times the keep keep-alive count.
      requestedMaxKeepAliveCount - the requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any notification to be sent, the subscription sends a keep-alive message to the client.
      maxNotificationsPerPublish - the maximum number of notifications that the client wishes to receive in a single publish response. A value of zero indicates that there is no limit.
      priority - indicates the relative priority of the subscription.
      Returns:
      the ModifySubscriptionResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • modifySubscriptionAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.ModifySubscriptionResponse> modifySubscriptionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, double requestedPublishingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedLifetimeCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestedMaxKeepAliveCount, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxNotificationsPerPublish, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte priority)
      Modify an existing Subscription belonging to this client's Session.
      Parameters:
      subscriptionId - the server-assigned identifier for the Subscription.
      requestedPublishingInterval - this interval defines the cyclic rate that the subscription is being requested to return notifications to the client. This interval is expressed in milliseconds.
      requestedLifetimeCount - the requested lifetime count. The lifetime count shall be a minimum of three times the keep keep-alive count.
      requestedMaxKeepAliveCount - the requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any notification to be sent, the subscription sends a keep-alive message to the client.
      maxNotificationsPerPublish - the maximum number of notifications that the client wishes to receive in a single publish response. A value of zero indicates that there is no limit.
      priority - indicates the relative priority of the subscription.
      Returns:
      a CompletableFuture that completes successfully with the ModifySubscriptionResponse, or completes exceptionally if there is an error invoking the service.

    • deleteSubscriptions

      public org.eclipse.milo.opcua.stack.core.types.structured.DeleteSubscriptionsResponse deleteSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds) throws org.eclipse.milo.opcua.stack.core.UaException
      Delete one or more Subscriptions belonging to this client's Session.
      Parameters:
      subscriptionIds - the server-assigned identifiers of the Subscriptions to delete.
      Returns:
      the DeleteSubscriptionsResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • deleteSubscriptionsAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteSubscriptionsResponse> deleteSubscriptionsAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds)
      Delete one or more Subscriptions belonging to this client's Session.
      Parameters:
      subscriptionIds - the server-assigned identifiers of the Subscriptions to delete.
      Returns:
      a CompletableFuture that completes successfully with the DeleteSubscriptionsResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • transferSubscriptions

      public org.eclipse.milo.opcua.stack.core.types.structured.TransferSubscriptionsResponse transferSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds, boolean sendInitialValues) throws org.eclipse.milo.opcua.stack.core.UaException
      Transfer a Subscription and its MonitoredItems from one Session to another (this) Session.
      Parameters:
      subscriptionIds - a List of server-assigned identifiers to be transferred to this Session.
      sendInitialValues - true if the first Publish response(s) after the transfer shall contain the current values of all MonitoredItems in the Subscription where the Monitoring Mode is set to MonitoringMode.Reporting.
      Returns:
      the TransferSubscriptionsResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • transferSubscriptionsAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TransferSubscriptionsResponse> transferSubscriptionsAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds, boolean sendInitialValues)
      Transfer a Subscription and its MonitoredItems from one Session to another (this) Session.
      Parameters:
      subscriptionIds - a List of server-assigned identifiers to be transferred to this Session.
      sendInitialValues - true if the first Publish response(s) after the transfer shall contain the current values of all MonitoredItems in the Subscription where the Monitoring Mode is set to MonitoringMode.Reporting.
      Returns:
      a CompletableFuture that completes successfully with the TransferSubscriptionsResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • setPublishingMode

      public org.eclipse.milo.opcua.stack.core.types.structured.SetPublishingModeResponse setPublishingMode(boolean publishingEnabled, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds) throws org.eclipse.milo.opcua.stack.core.UaException
      Enable or disable the sending of notifications on one or more subscriptions.
      Parameters:
      publishingEnabled - true if publishing is enabled.
      subscriptionIds - a List of server-assigned identifiers for subscriptions.
      Returns:
      the SetPublishingModeResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • setPublishingModeAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetPublishingModeResponse> setPublishingModeAsync(boolean publishingEnabled, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds)
      Enable or disable the sending of notifications on one or more subscriptions.
      Parameters:
      publishingEnabled - true if publishing is enabled.
      subscriptionIds - a List of server-assigned identifiers for subscriptions.
      Returns:
      a CompletableFuture that completes successfully with the SetPublishingModeResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • publish

      public org.eclipse.milo.opcua.stack.core.types.structured.PublishResponse publish(List<org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionAcknowledgement> subscriptionAcknowledgements) throws org.eclipse.milo.opcua.stack.core.UaException
      Send a PublishRequest to the server, acknowledging the receipt of previously-received messages and requesting the server return a NotificationMessage or keep-alive message.
      Parameters:
      subscriptionAcknowledgements - a List of SubscriptionAcknowledgements for one or more subscriptions.
      Returns:
      the PublishResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • publishAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.PublishResponse> publishAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionAcknowledgement> subscriptionAcknowledgements)
      Send a PublishRequest to the server, acknowledging the receipt of previously-received messages and requesting the server return a NotificationMessage or keep-alive message.
      Parameters:
      subscriptionAcknowledgements - a List of SubscriptionAcknowledgements for one or more subscriptions.
      Returns:
      a CompletableFuture that completes successfully with the PublishResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • republish

      public org.eclipse.milo.opcua.stack.core.types.structured.RepublishResponse republish(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger retransmitSequenceNumber) throws org.eclipse.milo.opcua.stack.core.UaException
      Send a RepublishRequest to the server, requesting the server republish a NotificationMessage from its retransmission queue.
      Parameters:
      subscriptionId - the server-assigned identifier for the Subscription.
      retransmitSequenceNumber - the sequence number of the NotificationMessage to be republished.
      Returns:
      the RepublishResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • republishAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.RepublishResponse> republishAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger subscriptionId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger retransmitSequenceNumber)
      Send a RepublishRequest to the server, requesting the server republish a NotificationMessage from its retransmission queue.
      Parameters:
      subscriptionId - the server-assigned identifier for the Subscription.
      retransmitSequenceNumber - the sequence number of the NotificationMessage to be republished.
      Returns:
      a CompletableFuture that completes successfully with the RepublishResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • browse

      public org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult browse(org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription nodeToBrowse) throws org.eclipse.milo.opcua.stack.core.UaException
      Browse references of a single Node.
      Parameters:
      nodeToBrowse - the Node to browse.
      Returns:
      the BrowseResult.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • browse

      public List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult> browse(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse) throws org.eclipse.milo.opcua.stack.core.UaException
      Browse references of one or more Nodes.
      Parameters:
      nodesToBrowse - the Nodes to browse.
      Returns:
      the BrowseResults.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • browse

      public org.eclipse.milo.opcua.stack.core.types.structured.BrowseResponse browse(org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription viewDescription, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxReferencesPerNode, List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse) throws org.eclipse.milo.opcua.stack.core.UaException
      Browse references of one or more Nodes.
      Parameters:
      viewDescription - a description of the view to browse. An empty ViewDescription indicates a view of the entire address space.
      maxReferencesPerNode - the maximum number of references to return for each starting Node specified in the request.
      nodesToBrowse - a List of Nodes to browse.
      Returns:
      the BrowseResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • browseAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResponse> browseAsync(org.eclipse.milo.opcua.stack.core.types.structured.ViewDescription viewDescription, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxReferencesPerNode, List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse)
      Browse references of one or more Nodes.
      Parameters:
      viewDescription - a description of the view to browse. An empty ViewDescription indicates a view of the entire address space.
      maxReferencesPerNode - the maximum number of references to return for each starting Node specified in the request.
      nodesToBrowse - a List of Nodes to browse.
      Returns:
      a CompletableFuture that completes successfully with the BrowseResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • browseAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult> browseAsync(org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription nodeToBrowse)
      Browse a single node, with no view and no max references specified.
      Parameters:
      nodeToBrowse - the node to browse.
      Returns:
      a CompletableFuture containing the BrowseResult.
      See Also:

    • browseAsync

      public CompletableFuture<List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseResult>> browseAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowseDescription> nodesToBrowse)
      Browse a list of nodes, with no view and no max references specified.
      Parameters:
      nodesToBrowse - the nodes to browse.
      Returns:
      a CompletableFuture containing the BrowseResults.
      See Also:

    • browseNext

      public org.eclipse.milo.opcua.stack.core.types.structured.BrowseNextResponse browseNext(boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> continuationPoints) throws org.eclipse.milo.opcua.stack.core.UaException
      Request the next set of Browse or BrowseNext information that was too large to be sent in a single response.
      Parameters:
      releaseContinuationPoints - if true, the continuation points are released to free resources in the server. If false, they are used to get the next set of browse information.
      continuationPoints - server-defined opaque values that represent continuation points.
      Returns:
      the BrowseNextResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • browseNextAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseNextResponse> browseNextAsync(boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> continuationPoints)
      Request the next set of Browse or BrowseNext information that was too large to be sent in a single response.
      Parameters:
      releaseContinuationPoints - if true, the continuation points are released to free resources in the server. If false, they are used to get the next set of browse information.
      continuationPoints - server-defined opaque values that represent continuation points.
      Returns:
      a CompletableFuture that completes successfully with the BrowseNextResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • translateBrowsePaths

      public org.eclipse.milo.opcua.stack.core.types.structured.TranslateBrowsePathsToNodeIdsResponse translateBrowsePaths(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowsePath> browsePaths) throws org.eclipse.milo.opcua.stack.core.UaException
      Translate one or more BrowsePaths into NodeIds.
      Parameters:
      browsePaths - a List of BrowsePaths to translate.
      Returns:
      the TranslateBrowsePathsToNodeIdsResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • translateBrowsePathsAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TranslateBrowsePathsToNodeIdsResponse> translateBrowsePathsAsync(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowsePath> browsePaths)
      Translate one or more BrowsePaths into NodeIds.
      Parameters:
      browsePaths - a List of BrowsePaths to translate.
      Returns:
      a CompletableFuture that completes successfully with the TranslateBrowsePathsToNodeIdsResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • registerNodes

      public org.eclipse.milo.opcua.stack.core.types.structured.RegisterNodesResponse registerNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToRegister) throws org.eclipse.milo.opcua.stack.core.UaException
      Register NodeIds that the client intends to access repeatedly (e.g. read, write, call), allowing servers to set up anything needed so that the access operations are more efficient.
      Parameters:
      nodesToRegister - the NodeIds of the Nodes to register.
      Returns:
      the RegisterNodesResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • registerNodesAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.RegisterNodesResponse> registerNodesAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToRegister)
      Register Nodes that the client intends to access repeatedly (e.g. read, write, call), allowing servers to set up anything needed so that the access operations are more efficient.
      Parameters:
      nodesToRegister - the NodeIds of the Nodes to register.
      Returns:
      a CompletableFuture that completes successfully with the RegisterNodesResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • unregisterNodes

      public org.eclipse.milo.opcua.stack.core.types.structured.UnregisterNodesResponse unregisterNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToUnregister) throws org.eclipse.milo.opcua.stack.core.UaException
      Unregister Nodes that were previously registered with a Register Nodes service call.
      Parameters:
      nodesToUnregister - the NodeIds returned by the previous Register Nodes service call.
      Returns:
      the UnregisterNodesResponse.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.
      See Also:

    • unregisterNodesAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.UnregisterNodesResponse> unregisterNodesAsync(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToUnregister)
      Unregister Nodes that were previously registered with a Register Nodes service call.
      Parameters:
      nodesToUnregister - the NodeIds returned by the previous Register Nodes service call.
      Returns:
      a CompletableFuture that completes successfully with the UnregisterNodesResponse, or completes exceptionally if there is an error invoking the service.
      See Also:

    • sendRequest

      public org.eclipse.milo.opcua.stack.core.types.UaResponseMessageType sendRequest(org.eclipse.milo.opcua.stack.core.types.UaRequestMessageType request) throws org.eclipse.milo.opcua.stack.core.UaException
      Send a service request and wait for the service response.
      Parameters:
      request - the service request to send.
      Returns:
      the service response.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if there is an error invoking the service.

    • sendRequestAsync

      public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.UaResponseMessageType> sendRequestAsync(org.eclipse.milo.opcua.stack.core.types.UaRequestMessageType request)
      Send a service request asynchronously.
      Parameters:
      request - the service request to send.
      Returns:
      a CompletableFuture that completes successfully with the service response, or completes exceptionally if there is an error invoking the service.

    • addFaultListener

      public void addFaultListener(ServiceFaultListener faultListener)

    • removeFaultListener

      public void removeFaultListener(ServiceFaultListener faultListener)

    • addSessionActivityListener

      public void addSessionActivityListener(SessionActivityListener listener)

    • removeSessionActivityListener

      public void removeSessionActivityListener(SessionActivityListener listener)

    • addSessionInitializer

      public void addSessionInitializer(SessionFsm.SessionInitializer initializer)

    • removeSessionInitializer

      public void removeSessionInitializer(SessionFsm.SessionInitializer initializer)