org.eclipse.milo.opcua.sdk.client

Class OpcUaClient

java.lang.Object

org.eclipse.milo.opcua.sdk.client.OpcUaClient

All Implemented Interfaces:

AttributeServices, MethodServices, MonitoredItemServices, NodeManagementServices, SubscriptionServices, ViewServices, UaClient

public class OpcUaClient
extends Object
implements UaClient

Field Summary

Fields

Modifier and Type	Field and Description
static String	SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
OpcUaClient(OpcUaClientConfig config, UaStackClient stackClient)

Method Summary

Modifier and Type	Method and Description
void	addFaultListener(ServiceFaultListener faultListener)
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.AddNodesResponse>	addNodes(List<org.eclipse.milo.opcua.stack.core.types.structured.AddNodesItem> nodesToAdd)
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesResponse>	addReferences(List<org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesItem> referencesToAdd)
void	addSessionActivityListener(SessionActivityListener listener)
void	addSessionInitializer(SessionFsm.SessionInitializer initializer)
CompletableFuture<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) This service is used to discover the references of a specified node.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseNextResponse>	browseNext(boolean releaseContinuationPoints, List<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> continuationPoints) This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CallResponse>	call(List<org.eclipse.milo.opcua.stack.core.types.structured.CallMethodRequest> methodsToCall) This service is used to call (invoke) a list of methods.
CompletableFuture<UaClient>	connect() Connect to the configured endpoint.
static OpcUaClient	create(OpcUaClientConfig config) Create an OpcUaClient configured with config.
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, Function<OpcUaClientConfigBuilder,OpcUaClientConfig> buildConfig) 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.
CompletableFuture<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) This service is used to create and add one or more monitored items to a subscription.
CompletableFuture<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) This service is used to create a subscription.
CompletableFuture<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) This service is used to remove one or more monitored items of a subscription.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesResponse>	deleteNodes(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesItem> nodesToDelete)
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesResponse>	deleteReferences(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesItem> referencesToDelete)
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteSubscriptionsResponse>	deleteSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds) This service is invoked to delete one or more subscriptions that belong to the client's session.
CompletableFuture<OpcUaClient>	disconnect() Disconnect from the configured endpoint.
AddressSpace	getAddressSpace()
OpcUaClientConfig	getConfig()
org.eclipse.milo.opcua.stack.core.types.DataTypeManager	getDynamicDataTypeManager()
org.eclipse.milo.opcua.stack.core.serialization.SerializationContext	getDynamicSerializationContext()
org.eclipse.milo.opcua.stack.core.NamespaceTable	getNamespaceTable() Get the local copy of the server's NamespaceTable.
ObjectTypeManager	getObjectTypeManager()
CompletableFuture<OpcUaSession>	getSession()
UaStackClient	getStackClient()
org.eclipse.milo.opcua.stack.core.types.DataTypeManager	getStaticDataTypeManager()
org.eclipse.milo.opcua.stack.core.serialization.SerializationContext	getStaticSerializationContext()
OpcUaSubscriptionManager	getSubscriptionManager()
VariableTypeManager	getVariableTypeManager()
CompletableFuture<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) This Service is used to read historical values or Events of one or more Nodes.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateResponse>	historyUpdate(List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateDetails> historyUpdateDetails) This Service is used to update historical values or Events of one or more Nodes.
CompletableFuture<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) This service is used to modify monitored items of a subscription.
CompletableFuture<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) This service is used to modify a subscription.
org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader	newRequestHeader() Build a new RequestHeader using a null authentication token.
org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader	newRequestHeader(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId authToken) Build a new RequestHeader using 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) Build a new RequestHeader using authToken and a custom requestTimeout.
org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader	newRequestHeader(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestTimeout) Build a new RequestHeader using a null authentication token and a custom requestTimeout.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.PublishResponse>	publish(List<org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionAcknowledgement> subscriptionAcknowledgements) This service is used for two purposes.
CompletableFuture<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) This service is used to read one or more attributes of one or more nodes.
org.eclipse.milo.opcua.stack.core.NamespaceTable	readNamespaceTable() Read the server's NamespaceTable and update the local copy.
CompletableFuture<org.eclipse.milo.opcua.stack.core.NamespaceTable>	readNamespaceTableAsync() Read the server's NamespaceTable and update the local copy.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.RegisterNodesResponse>	registerNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToRegister) The RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g.
void	removeFaultListener(ServiceFaultListener faultListener)
void	removeSessionActivityListener(SessionActivityListener listener)
void	removeSessionInitializer(SessionFsm.SessionInitializer initializer)
CompletableFuture<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) This service requests the subscription to republish a notification message from its retransmission queue.
<T extends org.eclipse.milo.opcua.stack.core.serialization.UaResponseMessage> CompletableFuture<T>	sendRequest(org.eclipse.milo.opcua.stack.core.serialization.UaRequestMessage request) Send a UaRequestMessage.
CompletableFuture<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) This service is used to set the MonitoringMode for one or more monitored items of a subscription.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetPublishingModeResponse>	setPublishingMode(boolean publishingEnabled, List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds) This service is used to enable sending of notifications on one or more subscriptions.
CompletableFuture<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) This service is used to create and delete triggering links for a triggering item.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TransferSubscriptionsResponse>	transferSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds, boolean sendInitialValues) This service is used to transfer a subscription and its monitored items from one session to another.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TranslateBrowsePathsToNodeIdsResponse>	translateBrowsePaths(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowsePath> browsePaths) This service is used to request that the server translates one or more browse paths to NodeIds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.UnregisterNodesResponse>	unregisterNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToUnregister) This service is used to unregister NodeIds that have been register via the RegisterNodes service.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.WriteResponse>	write(List<org.eclipse.milo.opcua.stack.core.types.structured.WriteValue> writeValues) This service is used to write values to one or more attributes of one or more nodes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.api.services.AttributeServices

read, readValue, readValues, writeValue, writeValues

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.api.services.MethodServices

call

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.api.services.ViewServices

browse, browse, browseNext

Field Detail

SDK_VERSION

public static final String SDK_VERSION

Constructor Detail

OpcUaClient

public OpcUaClient(OpcUaClientConfig config,
                   UaStackClient stackClient)

Method Detail

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:

an OpcUaClient configured with config.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if the client could not be created (e.g. transport/encoding not supported).

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, Function) 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,
                                 Function<OpcUaClientConfigBuilder,OpcUaClientConfig> buildConfig)
                          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.

buildConfig - a function that configures an OpcUaClientConfigBuilder and then builds and returns an OpcUaClientConfig.

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.

getConfig

public OpcUaClientConfig getConfig()

Specified by:

getConfig in interface UaClient

Returns:

the OpcUaClientConfig for this client.

getStackClient

public UaStackClient getStackClient()

getAddressSpace

public AddressSpace getAddressSpace()

Specified by:

getAddressSpace in interface UaClient

Returns:

the AddressSpace.

getObjectTypeManager

public ObjectTypeManager getObjectTypeManager()

getVariableTypeManager

public VariableTypeManager getVariableTypeManager()

getStaticDataTypeManager

public org.eclipse.milo.opcua.stack.core.types.DataTypeManager getStaticDataTypeManager()

See Also:

UaStackClient.getStaticDataTypeManager()

getDynamicDataTypeManager

public org.eclipse.milo.opcua.stack.core.types.DataTypeManager getDynamicDataTypeManager()

See Also:

UaStackClient.getDynamicDataTypeManager()

getStaticSerializationContext

public org.eclipse.milo.opcua.stack.core.serialization.SerializationContext getStaticSerializationContext()

See Also:

UaStackClient.getStaticSerializationContext()

getDynamicSerializationContext

public org.eclipse.milo.opcua.stack.core.serialization.SerializationContext getDynamicSerializationContext()

See Also:

UaStackClient.getDynamicSerializationContext()

getNamespaceTable

public org.eclipse.milo.opcua.stack.core.NamespaceTable getNamespaceTable()

Get the local copy of the server's NamespaceTable.

Returns:

the current local value for server's NamespaceTable.

readNamespaceTable

public org.eclipse.milo.opcua.stack.core.NamespaceTable readNamespaceTable()
                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Read the server's NamespaceTable 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 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.

newRequestHeader

public org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader newRequestHeader()

Build a new RequestHeader using a null authentication token.

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)

Build a new RequestHeader using authToken.

Parameters:

authToken - the authentication token (from the session) to use.

Returns:

a new RequestHeader.

newRequestHeader

public org.eclipse.milo.opcua.stack.core.types.structured.RequestHeader newRequestHeader(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestTimeout)

Build a new RequestHeader using a null authentication token and a custom requestTimeout.

Parameters:

requestTimeout - the custom request timeout to use.

Returns:

a new RequestHeader with a null authentication token and a custom request timeout.

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)

Build a new RequestHeader using authToken and a custom requestTimeout.

Parameters:

authToken - the authentication token (from the session) to use.

requestTimeout - the custom request timeout to use.

Returns:

a new RequestHeader.

connect

public CompletableFuture<UaClient> connect()

Description copied from interface: UaClient

Connect to the configured endpoint.

Specified by:

connect in interface UaClient

Returns:

a CompletableFuture holding this client instance.

disconnect

public CompletableFuture<OpcUaClient> disconnect()

Description copied from interface: UaClient

Disconnect from the configured endpoint.

Specified by:

disconnect in interface UaClient

Returns:

a CompletableFuture holding this client instance.

getSubscriptionManager

public OpcUaSubscriptionManager getSubscriptionManager()

Specified by:

getSubscriptionManager in interface UaClient

Returns:

the OpcUaSubscriptionManager for this client.

read

public CompletableFuture<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)

Description copied from interface: AttributeServices

This service is used to read one or more attributes of one or more nodes.

Specified by:

read in interface AttributeServices

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:

CompletableFuture containing the ReadResponse.

write

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.WriteResponse> write(List<org.eclipse.milo.opcua.stack.core.types.structured.WriteValue> writeValues)

Description copied from interface: AttributeServices

This service is used to write values to one or more attributes of one or more nodes.

Specified by:

write in interface AttributeServices

Parameters:

writeValues - the list of nodes and their attributes to write.

Returns:

a CompletableFuture containing the WriteResponse.

historyRead

public CompletableFuture<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)

Description copied from interface: AttributeServices

This Service is used to read historical values or Events of one or more Nodes.

Specified by:

historyRead in interface AttributeServices

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 containing the HistoryReadResponse.

historyUpdate

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateResponse> historyUpdate(List<org.eclipse.milo.opcua.stack.core.types.structured.HistoryUpdateDetails> historyUpdateDetails)

Description copied from interface: AttributeServices

This Service is used to update historical values or Events of one or more Nodes.

Specified by:

historyUpdate in interface AttributeServices

Parameters:

historyUpdateDetails - the details defined for this update.

Returns:

a CompletableFuture containing the HistoryUpdateResponse.

browse

public CompletableFuture<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)

Description copied from interface: ViewServices

This service is used to discover the references of a specified node.

The browse can be further limited by the use of a view. The Browse service also supports a primitive filtering capability.

Specified by:

browse in interface ViewServices

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 containing the BrowseResponse.

browseNext

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.BrowseNextResponse> browseNext(boolean releaseContinuationPoints,
                                                                                                           List<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> continuationPoints)

Description copied from interface: ViewServices

This service is used to request the next set of Browse or BrowseNext response information that is too large to be sent in a single response.

“Too large” in this context means that the server is not able to return a larger response or that the number of results to return exceeds the maximum number of results to return that was specified by the client in the original Browse request.

Specified by:

browseNext in interface ViewServices

Parameters:

releaseContinuationPoints - if true, passed continuationPoints shall be reset to free resources in the server. If false, passed continuationPoints shall be used to get the next set of browse information.

continuationPoints - a list of server-defined opaque values that represent continuation points.

Returns:

a CompletableFuture containing the BrowseNextResponse.

translateBrowsePaths

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TranslateBrowsePathsToNodeIdsResponse> translateBrowsePaths(List<org.eclipse.milo.opcua.stack.core.types.structured.BrowsePath> browsePaths)

Description copied from interface: ViewServices

This service is used to request that the server translates one or more browse paths to NodeIds.

Each browse path is constructed of a starting NodeId and a RelativePath. The specified starting node identifies the node from which the RelativePath is based.

Specified by:

translateBrowsePaths in interface ViewServices

Parameters:

browsePaths - a list of browse paths for which NodeIds are being requested.

Returns:

a CompletableFuture containing the TranslateBrowsePathsToNodeIdsResponse.

registerNodes

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.RegisterNodesResponse> registerNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToRegister)

Description copied from interface: ViewServices

The RegisterNodes service can be used by clients to register the nodes that they know they will access repeatedly (e.g. Write, Call). It allows servers to set up anything needed so that the access operations will be more efficient.

Specified by:

registerNodes in interface ViewServices

Parameters:

nodesToRegister - a list of NodeIds to register.

Returns:

a CompletableFuture containing the RegisterNodesResponse.

unregisterNodes

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.UnregisterNodesResponse> unregisterNodes(List<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> nodesToUnregister)

Description copied from interface: ViewServices

This service is used to unregister NodeIds that have been register via the RegisterNodes service.

Specified by:

unregisterNodes in interface ViewServices

Parameters:

nodesToUnregister - a list of NodeIds to unregister.

Returns:

a CompletableFuture containing the UnregisterNodesResponse.

call

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.CallResponse> call(List<org.eclipse.milo.opcua.stack.core.types.structured.CallMethodRequest> methodsToCall)

Description copied from interface: MethodServices

This service is used to call (invoke) a list of methods. Each method call is invoked within the context of an existing session. If the session is terminated, the results of the method’s execution cannot be returned to the client and are discarded. This is independent of the task actually performed at the server.

Specified by:

call in interface MethodServices

Parameters:

methodsToCall - a list of methods to call.

Returns:

a CompletableFuture containing the CallResponse.

createSubscription

public CompletableFuture<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)

Description copied from interface: SubscriptionServices

This service is used to create a subscription. Subscriptions monitor a set of monitored items for notifications and return them to the client in response to Publish requests.

Specified by:

createSubscription in interface SubscriptionServices

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 containing the CreateSubscriptionResponse.

modifySubscription

public CompletableFuture<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)

Description copied from interface: SubscriptionServices

This service is used to modify a subscription.

Specified by:

modifySubscription in interface SubscriptionServices

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 containing the ModifySubscriptionResponse.

deleteSubscriptions

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteSubscriptionsResponse> deleteSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds)

Description copied from interface: SubscriptionServices

This service is invoked to delete one or more subscriptions that belong to the client's session.

Specified by:

deleteSubscriptions in interface SubscriptionServices

Parameters:

subscriptionIds - the server-assigned identifiers for the subscriptions.

Returns:

a CompletableFuture containing the DeleteSubscriptionsResponse.

transferSubscriptions

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.TransferSubscriptionsResponse> transferSubscriptions(List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds,
                                                                                                                                 boolean sendInitialValues)

Description copied from interface: SubscriptionServices

This service is used to transfer a subscription and its monitored items from one session to another.

Specified by:

transferSubscriptions in interface SubscriptionServices

Parameters:

subscriptionIds - the server-assigned identifiers for the subscriptions to transfer.

sendInitialValues - if true, the first Publish response after the TransferSubscriptions service call shall contain the current values of all monitored items in the subscription where the MonitoringMode is MonitoringMode.Reporting.

Returns:

a CompletableFuture containing the TransferSubscriptionsResponse.

setPublishingMode

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.SetPublishingModeResponse> setPublishingMode(boolean publishingEnabled,
                                                                                                                         List<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> subscriptionIds)

Description copied from interface: SubscriptionServices

This service is used to enable sending of notifications on one or more subscriptions.

Specified by:

setPublishingMode in interface SubscriptionServices

Parameters:

publishingEnabled - true if publishing of notification messages is to be enabled.

subscriptionIds - a list of server-assigned subscription identifiers to enable or disable publishing on.

Returns:

a CompletableFuture containing the SetPublishingModeResponse.

publish

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.PublishResponse> publish(List<org.eclipse.milo.opcua.stack.core.types.structured.SubscriptionAcknowledgement> subscriptionAcknowledgements)

Description copied from interface: SubscriptionServices

This service is used for two purposes. First, it is used to acknowledge the receipt of notification messages for one or more subscriptions. Second, it is used to request the server to return a notification message or a keep-alive message.

Specified by:

publish in interface SubscriptionServices

Parameters:

subscriptionAcknowledgements - the list of acknowledgements for one or more subscriptions. This list may contain multiple acknowledgements for the same subscription (multiple entries with the same subscriptionId).

Returns:

a CompletableFuture containing the PublishResponse.

republish

public CompletableFuture<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)

Description copied from interface: SubscriptionServices

This service requests the subscription to republish a notification message from its retransmission queue. If the server does not have the requested message in its retransmission queue, it returns an error response.

Specified by:

republish in interface SubscriptionServices

Parameters:

subscriptionId - the server-assigned identifier for the subscription to be republished.

retransmitSequenceNumber - the sequence number of a specific notification message to be republished.

Returns:

a CompletableFuture containing the RepublishResponse.

createMonitoredItems

public CompletableFuture<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)

Description copied from interface: MonitoredItemServices

This service is used to create and add one or more monitored items to a subscription.

Specified by:

createMonitoredItems in interface MonitoredItemServices

Parameters:

subscriptionId - the server-assigned identifier for the subscription that will report notifications for the monitored items.

timestampsToReturn - the TimestampsToReturn.

itemsToCreate - a list of monitored items to be created and assigned to the specified subscription.

Returns:

a CompletableFuture containing the CreateMonitoredItemsResponse.

modifyMonitoredItems

public CompletableFuture<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)

Description copied from interface: MonitoredItemServices

This service is used to modify monitored items of a subscription.

Specified by:

modifyMonitoredItems in interface MonitoredItemServices

Parameters:

subscriptionId - the server-assigned identifier of the subscription the items to modify belong to.

timestampsToReturn - the TimestampsToReturn.

itemsToModify - a list of monitored items to modify.

Returns:

a CompletableFuture containing the ModifyMonitoredItemsResponse.

deleteMonitoredItems

public CompletableFuture<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)

Description copied from interface: MonitoredItemServices

This service is used to remove one or more monitored items of a subscription.

Specified by:

deleteMonitoredItems in interface MonitoredItemServices

Parameters:

subscriptionId - the server-assigned identifier of the subscription the items to delete belong to.

monitoredItemIds - a list of server-assigned identifiers for the items to delete.

Returns:

a CompletableFuture containing the DeleteMonitoredItemsResponse.

setMonitoringMode

public CompletableFuture<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)

Description copied from interface: MonitoredItemServices

This service is used to set the MonitoringMode for one or more monitored items of a subscription.

Setting the mode to MonitoringMode.Disabled causes all queued notifications to be deleted.

Specified by:

setMonitoringMode in interface MonitoredItemServices

Parameters:

subscriptionId - the server-assigned identifier of the subscription the items belong to.

monitoringMode - the MonitoringMode to be set for the monitored items.

monitoredItemIds - a list of server-assigned identifiers for the items whose MonitoringMode will be set.

Returns:

a CompletableFuture containing the SetMonitoringModeResponse.

setTriggering

public CompletableFuture<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)

Description copied from interface: MonitoredItemServices

This service is used to create and delete triggering links for a triggering item. The triggering item and the items to report shall belong to the same subscription.

Specified by:

setTriggering in interface MonitoredItemServices

Parameters:

subscriptionId - the server-assigned identifier for the subscription that contains the triggering item and the items to report.

triggeringItemId - the server-assigned identifier for the monitored item used as the triggering item.

linksToAdd - the list of server-assigned identifiers of the items to report that are to be added as triggering links. The list of links to remove is processed before the links to add.

linksToRemove - the list of server-assigned identifiers of the items to report for the triggering links to be removed. The list of links to remove is processed before the links to add.

Returns:

a CompletableFuture containing the SetTriggeringResponse.

addNodes

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.AddNodesResponse> addNodes(List<org.eclipse.milo.opcua.stack.core.types.structured.AddNodesItem> nodesToAdd)

Specified by:

addNodes in interface NodeManagementServices

addReferences

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesResponse> addReferences(List<org.eclipse.milo.opcua.stack.core.types.structured.AddReferencesItem> referencesToAdd)

Specified by:

addReferences in interface NodeManagementServices

deleteNodes

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesResponse> deleteNodes(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteNodesItem> nodesToDelete)

Specified by:

deleteNodes in interface NodeManagementServices

deleteReferences

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesResponse> deleteReferences(List<org.eclipse.milo.opcua.stack.core.types.structured.DeleteReferencesItem> referencesToDelete)

Specified by:

deleteReferences in interface NodeManagementServices

getSession

public CompletableFuture<OpcUaSession> getSession()

Specified by:

getSession in interface UaClient

Returns:

a CompletableFuture holding the UaSession.

sendRequest

public <T extends org.eclipse.milo.opcua.stack.core.serialization.UaResponseMessage> CompletableFuture<T> sendRequest(org.eclipse.milo.opcua.stack.core.serialization.UaRequestMessage request)

Description copied from interface: UaClient

Send a UaRequestMessage.

Specified by:

sendRequest in interface UaClient

Parameters:

request - the request to send.

Returns:

a CompletableFuture holding the response.

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)