UaClient (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.UaApplication
- - com.prosysopc.ua.client.UaClient

Direct Known Subclasses:

UaLoopbackClient
```
public class UaClient
extends UaApplication
```
A client connection interface to an OPC UA server.
The Client implements main OPC UA client functionality, so that you can configure the server connection properties through it and connect to the specified server.
The connection is defined by the properties Protocol, Host and Port and ServerName. Alternatively, you can define URI, which is composed of those parameters.
In addition, you can define the SecurityMode, ClientIdentity and UserIdentity, which are used to define the connection security settings. When connected, you can access the ServerIdentity.
You can then connect() to the server, and start communications. You can check the Status of the server, or addServerStatusListener(ServerStatusListener) to monitor changes in the quality of the connection.
For communications, you can use the various read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) and write(com.prosysopc.ua.stack.core.WriteValue...) methods, or addSubscription(com.prosysopc.ua.client.Subscription) to monitor server data changes or notifications.
You can also call(com.prosysopc.ua.stack.core.CallMethodRequest...) server methods.
Note: although the class is not declared as final, it is not really designed for inheritance.

Nested Class Summary
- Nested classes/interfaces inherited from class com.prosysopc.ua.UaApplication
  UaApplication.DiagnosticMask, UaApplication.Protocol

Field Summary

Fields
Modifier and Type Field and Description

static Double MAX_CACHE_AGE
Maximum possible value for setDefaultMaxAge(double), based on the Read service call definitions.

Fields
Modifier and Type	Field and Description
`static Double`	`MAX_CACHE_AGE` Maximum possible value for `setDefaultMaxAge(double)`, based on the Read service call definitions.

Constructor Summary

Constructors
Constructor and Description
`UaClient()` Create a new server connection.
`UaClient(String address)` Create a server connection using the given server connection address.
`UaClient(UaAddress address)` Create a server connection using the given server connection address.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addServerStatusListener(ServerStatusListener serverStatusListener)` Add a new listener for the ServerStatus events.
`Subscription`	`addSubscription(Subscription subscription)` Create a new subscription and add it to Subscriptions.
`protected void`	`addSubscriptionAck(SubscriptionAcknowledgement ack)`
`CallResponse`	`call(CallMethodRequest... MethodsToCall)` Call several methods at once.
`Variant[]`	`call(NodeId objectId, NodeId methodId, Variant... inputArguments)` Call a method in the server.
`AsyncResult<CallResponse>`	`callAsync(CallMethodRequest... methodsToCall)` Call several methods asynchronously.
`void`	`connect()` Connect to the OPC UA server.
`void`	`disconnect()` Disconnect from the server.
`void`	`disconnect(long timeout)` Disconnect from the server.
`void`	`disconnect(long timeout, TimeUnit timeUnit)`
`void`	`disconnect(UnsignedInteger timeout)` Disconnect from the server.
`EndpointDescription[]`	`discoverEndpoints()` Find the list of server end-points corresponding to `getProtocol()`.
`EndpointDescription[]`	`discoverEndpoints(UaApplication.Protocol... protocols)` Find the list of server end-points corresponding to the defined protocols.
`OperationLimits`	`getActualOperationLimits()` Returns the actual operation limits i.e.
`int`	`getActualPublishRequestSetpoint()`
`UaAddress`	`getAddress()` Returns the connection address of the OPC UA server.
`AddressSpace`	`getAddressSpace()` AddressSpace object used for browsing the addres space of the server and for using the View services.
`ApplicationIdentity`	`getApplicationIdentity()` The identity information of your OPC UA client application.
`String`	`getAuditEntryId()` Audit entry to include in service calls.
`static Set<StatusCode>`	`getCommErrorCodes()` Returns a Set of StatusCodes that indicate a communication error between the Client and the Server when checking Server status and communication error filtering has been enabled with `setCommunicationErrorFilteringEnabled` or when handling PublishResponse errors.
`int`	`getConnectTimeout()` Connection timeout in milliseconds.
`double`	`getDefaultMaxAge()` Get the default maxAge parameter used in Reads when none specified.
`static UaApplication.Protocol`	`getDefaultProtocol()` The default protocol to use for URI, if none is defined in #setUri()
`TimestampsToReturn`	`getDefaultTimestampsToReturn()` Get the default timestampsToReturn parameter used in Reads when none is specified
`EncoderContext`	`getEncoderContext()`
`EndpointDescription`	`getEndpoint()` The server endpoint that is used.
`EndpointConfiguration`	`getEndpointConfiguration()` Configuration parameters for the channel and endpoint.
`String`	`getHost()` Deprecated. use `getAddress()` and `UaAddress.getHost()`
`protected HttpsSecurityPolicy[]`	`getHttpsSecurityPolicies()` The TLS security policies used for HTTPS communications.
`HttpsSettings`	`getHttpsSettings()`
`DiagnosticInfo[]`	`getLastOperationDiagnostics()` The operation level diagnostic information related to the last service call.
`DateTime`	`getLastResponseTimestamp()` The timestamps of the response message of the last service call.
`DiagnosticInfo`	`getLastServiceDiagnostics()` The service level diagnostic information related to the last service call.
`StatusCode`	`getLastServiceResult()`
`UaClientListener`	`getListener()`
`Locale`	`getLocale()` The currently defined user locale.
`UnsignedInteger`	`getMaxResponseMessageSize()`
`NamespaceTable`	`getNamespaceTable()` The server NamespaceTable.
`NamespaceTable`	`getNamespaceTable(boolean forceRefresh)` The server NamespaceTable.
`EnumSet<UaApplication.DiagnosticMask>`	`getOperationDiagnosticMask()` The currently requested operation diagnostics.
`int`	`getPort()` Deprecated. use `getAddress()` and `UaAddress.getPort()`
`UaApplication.Protocol`	`getProtocol()` Deprecated. use `getAddress()` and `UaAddress.getProtocol()`
`double`	`getPublishRequestFactor()`
`int`	`getPublishRequestSetpoint()` The current target of PublishRequests to send to the server.
`UnsignedInteger`	`getPublishRequestTimeout()`
`UaAddress`	`getReverseAddress()`
`ReverseConnectionListener`	`getReverseConnectionListener()`
`SecureChannel`	`getSecureChannel()`
`SecurityMode`	`getSecurityMode()`
`ApplicationIdentity`	`getServerIdentity()`
`String`	`getServerName()` Deprecated. use `getAddress()` and `UaAddress.getServerName()`
`ServerState`	`getServerState()` The current state of the server.
`ServerStatusDataType`	`getServerStatus()` The status of the server that we are connected.
`StatusCode`	`getServerStatusError()` In case the monitoring of Server Status fails, the related error code is available from here.
`ServerTable`	`getServerTable()` Returns the server's ServerTable (from node `VariableIdentifiers.Server_ServerArray`).
`ServerTable`	`getServerTable(boolean forceRefresh)` The server ServerTable.
`long`	`getServerTimeDifference()` The current time difference between the server and the client.
`EnumSet<UaApplication.DiagnosticMask>`	`getServiceDiagnosticMask()`
`Session`	`getSession()` The current session.
`String`	`getSessionName()`
`double`	`getSessionTimeout()`
`TcpConnection.SocketFactory`	`getSocketFactory()` Returns the `TcpConnection.SocketFactory` previously set via `#setSocketFactory(SocketFactory)`.
`long`	`getStatusCheckInterval()`
`long`	`getStatusCheckTimeout()` The timeout used for Server Status reads in `updateServerStatus()`
`Subscription`	`getSubscription(int index)` Get a subscription by index.
`Subscription`	`getSubscriptionById(UnsignedInteger subscriptionId)` Get a subscription with the subscription ID specified by the server.
`int`	`getSubscriptionCount()` Number of defined subscriptions.
`Subscription[]`	`getSubscriptions()` Get subscriptions.
`List<SecurityMode>`	`getSupportedSecurityModes()` Get a list of security modes supported by the server.
`UserTokenPolicy[]`	`getSupportedUserIdentityTokens()` Find out the user identity types supported by the server.
`int`	`getTimeout()` The default communication request timeout.
`TypeDictionary`	`getTypeDictionary()` Returns a `TypeDictionary` that can be used to parse unknown Structures.
`String`	`getUri()` Deprecated. use `getAddress()` and `UaAddress.getAddress()`
`UserIdentity`	`getUserIdentity()` The current user identity to use for user authentication.
`boolean`	`hasConnected()` Returns true if a successful `connect()` has happened (i.e.
`boolean`	`hasConnection()` Best-effort answers to "Are we currently connected to the server?".
`boolean`	`hasServerStatusListener(ServerStatusListener serverStatusListener)` Check if the client already has the specified server status listener.
`boolean`	`hasSubscription(UnsignedInteger subscriptionId)` Checks if the client has a subscription with the specified ID.
`HistoryUpdateResult`	`historyDeleteAtTimes(NodeId nodeId, DateTime[] reqTimes)` Deletes history at specified times.
`HistoryUpdateResult`	`historyDeleteEvents(NodeId nodeId, List<ByteString> eventIds)` Deletes specified events from history.
`HistoryUpdateResult`	`historyDeleteModified(NodeId nodeId, DateTime startTime, DateTime endTime)` Deletes modified history from a specified interval.
`HistoryUpdateResult`	`historyDeleteRaw(NodeId nodeId, DateTime startTime, DateTime endTime)` Deletes raw history from a specified interval.
`HistoryReadResult[]`	`historyRead(HistoryReadDetails details, TimestampsToReturn timestampsToReturn, Boolean releaseContinuationPoints, HistoryReadValueId... nodesToRead)` Read history of nodes.
`AsyncResult<HistoryReadResponse>`	`historyReadAsync(HistoryReadDetails details, TimestampsToReturn timestampsToReturn, Boolean releaseContinuationPoints, HistoryReadValueId... nodesToRead)` Read history of nodes asynchronously.
`HistoryReadResult[]`	`historyReadAtTimes(NodeId[] nodeIds, DateTime[] reqTimes, NumericRange indexRange, TimestampsToReturn timestampsToReturn, Boolean useSimpleBounds)` Reads history at specified times.
`DataValue[]`	`historyReadAtTimes(NodeId nodeId, DateTime[] reqTimes, NumericRange indexRange, TimestampsToReturn timestampsToReturn)` Reads history at specified times.
`DataValue[]`	`historyReadAtTimes(NodeId nodeId, DateTime[] reqTimes, NumericRange indexRange, TimestampsToReturn timestampsToReturn, Boolean useSimpleBounds)` Reads history at specified times.
`HistoryReadResult[]`	`historyReadEvents(NodeId[] nodeIds, DateTime startTime, DateTime endTime, UnsignedInteger numValuesPerNode, EventFilter filter, TimestampsToReturn timestampsToReturn)` Reads events from history.
`HistoryEventFieldList[]`	`historyReadEvents(NodeId nodeId, DateTime startTime, DateTime endTime, UnsignedInteger numValuesPerNode, EventFilter filter, TimestampsToReturn timestampsToReturn)` Reads events from history.
`HistoryReadResult[]`	`historyReadModified(NodeId[] nodeIds, DateTime startTime, DateTime endTime, UnsignedInteger numValuesPerNode, NumericRange indexRange, TimestampsToReturn timestampsToReturn)` Reads Modified values from the history.
`HistoryModifiedData`	`historyReadModified(NodeId nodeId, DateTime startTime, DateTime endTime, UnsignedInteger numValuesPerNode, NumericRange indexRange, TimestampsToReturn timestampsToReturn)` Reads Modified values from the history.
`HistoryReadResult[]`	`historyReadProcessed(NodeId[] nodeIds, DateTime startTime, DateTime endTime, Double processingInterval, NodeId aggregateType, AggregateConfiguration aggregateConfiguration, NumericRange indexRange, TimestampsToReturn timestampsToReturn)` Reads processed history data.
`DataValue[]`	`historyReadProcessed(NodeId nodeId, DateTime startTime, DateTime endTime, Double processingInterval, NodeId aggregateType, AggregateConfiguration aggregateConfiguration, NumericRange indexRange, TimestampsToReturn timestampsToReturn)` Reads processed history data.
`HistoryReadResult[]`	`historyReadRaw(NodeId[] nodeIds, DateTime startTime, DateTime endTime, long numValuesPerNode, Boolean returnBounds, NumericRange indexRange, TimestampsToReturn timestampsToReturn)` Reads raw history data.
`DataValue[]`	`historyReadRaw(NodeId nodeId, DateTime startTime, DateTime endTime, long numValuesPerNode, Boolean returnBounds, NumericRange indexRange, TimestampsToReturn timestampsToReturn)` Reads raw history data.
`DataValue[]`	`historyReadRaw(NodeId nodeId, DateTime startTime, DateTime endTime, UnsignedInteger numValuesPerNode, Boolean returnBounds, NumericRange indexRange, TimestampsToReturn timestampsToReturn)` Reads raw history data.
`HistoryUpdateResult[]`	`historyUpdate(HistoryUpdateDetails... details)` Update history data in the server.
`AsyncResult<HistoryUpdateResponse>`	`historyUpdateAsync(HistoryUpdateDetails... details)` Update history data in the server.
`HistoryUpdateResult`	`historyUpdateData(NodeId nodeId, PerformUpdateType performInsertReplace, DataValue[] updateValues)` Updates history data.
`HistoryUpdateResult`	`historyUpdateEvent(NodeId nodeId, PerformUpdateType performInsertReplace, EventFilter filter, HistoryEventFieldList[] eventData)` Updates historical events in the server.
`HistoryUpdateResult`	`historyUpdateStructureData(NodeId nodeId, PerformUpdateType performInsertReplace, DataValue[] updateValues)` Updates historical structure data.
`boolean`	`isAutoReconnect()` Automatic reconnection setting.
`boolean`	`isConnected()` Deprecated. use `hasConnection()` or `hasConnected()` instead.
`boolean`	`isInitTypeDictionaryAutoUsage()` Returns true if `TypeDictionary` is read automatically when first encountering custom Structures, unless already initialized at connect as defined by `isInitTypeDictionaryOnConnect()`.
`boolean`	`isInitTypeDictionaryOnConnect()` Returns true if `TypeDictionary` is read automatically, when connecting to the server.
`boolean`	`isInitTypeDictionaryShallow()` See `setInitTypeDictionaryShallow(boolean)`.
`boolean`	`isInReverseMode()` Defines whether the client is expecting a Reverse Connection from a server.
`boolean`	`isKeepSubscriptions()` Defines whether subscriptions should be kept in the server after `disconnect()`.
`static boolean`	`isUseCommErrorCodes()` Returns value set to `setUseCommErrorCodes(boolean)`.
`boolean`	`isValidateCreateSessionResponseCert()` Define whether the client should validate the server certificate received at session creation.
`boolean`	`isValidateDiscoveredEndpoints()` Define whether the client should validate the server endpoints received at session creation against those returned for `discoverEndpoints()`.
`boolean`	`isValidateNonceLength()` Define whether the client should validate the length of the nonce received at session creation.
`ReadResponse`	`read(Double maxAge, TimestampsToReturn timestampsToReturn, ReadValueId... nodesToRead)` This Service is used to read one or more Attributes of one or more Nodes.
`AsyncResult<ReadResponse>`	`readAsync(Double maxAge, TimestampsToReturn timestampsToReturn, ReadValueId... nodesToRead)` Read node attributes from the server asynchronously.
`DataValue`	`readAttribute(ExpandedNodeId nodeId, UnsignedInteger attributeId)` Reads the value for the specified single node attribute.
`DataValue`	`readAttribute(ExpandedNodeId nodeId, UnsignedInteger attributeId, NumericRange indexRange, Double maxCacheAge)` Reads the value for the specified single node attribute.
`DataValue`	`readAttribute(NodeId nodeId, UnsignedInteger attributeId)` Reads the value for the specified single node attribute.
`DataValue`	`readAttribute(NodeId nodeId, UnsignedInteger attributeId, NumericRange indexRange, Double maxCacheAge)` Reads the value for the specified single node attribute.
`DataValue`	`readAttribute(UaNodeId nodeId, UnsignedInteger attributeId)` Reads the value for the specified single node attribute.
`DataValue`	`readAttribute(UaNodeId nodeId, UnsignedInteger attributeId, NumericRange indexRange, Double maxCacheAge)` Reads the value for the specified single node attribute.
`DataValue[]`	`readAttributes(ExpandedNodeId nodeId, UnsignedInteger... attributeIds)` Read all attributes of a Node.
`DataValue[]`	`readAttributes(ExpandedNodeId nodeId, UnsignedInteger[] attributeIds, NumericRange[] indexRanges, Double maxCacheAge)` Read all attributes of a Node.
`DataValue[]`	`readAttributes(NodeId nodeId, UnsignedInteger... attributeIds)` Read all attributes of a Node.
`DataValue[]`	`readAttributes(NodeId nodeId, UnsignedInteger[] attributeIds, NumericRange[] indexRanges, Double maxCacheAge)` Read all attributes of a Node.
`DataValue[]`	`readAttributes(UaNodeId nodeId, UnsignedInteger... attributeIds)` Read all attributes of a Node.
`DataValue[]`	`readAttributes(UaNodeId nodeId, UnsignedInteger[] attributeIds, NumericRange[] indexRanges, Double maxCacheAge)` Read all attributes of a Node.
`DataValue`	`readValue(ExpandedNodeId nodeId)` Reads the value attribute of a node.
`DataValue`	`readValue(ExpandedNodeId nodeId, Double maxCacheAge)` Reads the value attribute of a node.
`DataValue`	`readValue(ExpandedNodeId nodeId, NumericRange indexRange)` Reads the value attribute of a node.
`DataValue`	`readValue(ExpandedNodeId nodeId, NumericRange indexRange, Double maxCacheAge)` Reads the value attribute of a node.
`DataValue`	`readValue(NodeId nodeId)` Reads the value attribute of a node.
`DataValue`	`readValue(NodeId nodeId, Double maxCacheAge)` Reads the value attribute of a node.
`DataValue`	`readValue(NodeId nodeId, NumericRange indexRange)` Reads the value attribute of a node.
`DataValue`	`readValue(NodeId nodeId, NumericRange indexRange, Double maxCacheAge)` Reads the value attribute of a node.
`DataValue`	`readValue(UaNodeId nodeId)` Reads the value attribute of a node.
`DataValue`	`readValue(UaNodeId nodeId, Double maxCacheAge)` Reads the value attribute of a node.
`DataValue`	`readValue(UaNodeId nodeId, NumericRange indexRange)` Reads the value attribute of a node.
`DataValue`	`readValue(UaNodeId nodeId, NumericRange indexRange, Double maxCacheAge)` Reads the value attribute of a node.
`DataValue[]`	`readValues(ExpandedNodeId[] nodeIds)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(ExpandedNodeId[] nodeIds, NumericRange[] indexRanges)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(ExpandedNodeId[] nodeIds, NumericRange[] indexRanges, TimestampsToReturn timestamps)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(ExpandedNodeId[] nodeIds, NumericRange[] indexRanges, TimestampsToReturn timestamps, Double maxCacheAge)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(ExpandedNodeId[] nodeIds, TimestampsToReturn timestamps)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(NodeId[] nodeIds)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(NodeId[] nodeIds, NumericRange[] indexRanges)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(NodeId[] nodeIds, NumericRange[] indexRanges, TimestampsToReturn timestamps)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(NodeId[] nodeIds, NumericRange[] indexRanges, TimestampsToReturn timestamps, Double maxCacheAge)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(NodeId[] nodeIds, TimestampsToReturn timestamps)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(UaNodeId[] nodeIds)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(UaNodeId[] nodeIds, NumericRange[] indexRanges)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(UaNodeId[] nodeIds, NumericRange[] indexRanges, TimestampsToReturn timestamps)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(UaNodeId[] nodeIds, NumericRange[] indexRanges, TimestampsToReturn timestamps, Double maxCacheAge)` Reads the value attribute of several nodes at once.
`DataValue[]`	`readValues(UaNodeId[] nodeIds, TimestampsToReturn timestamps)` Reads the value attribute of several nodes at once.
`boolean`	`reconnect()` Reconnect to the server.
`void`	`registerModel(ClientCodegenModel codegenModel)` Register an information model to use in the application.
`boolean`	`removeServerStatusListener(ServerStatusListener serverStatusListener)` Remove a listener from the ServerStatus events.
`StatusCode`	`removeSubscription(Subscription subscription)` Remove the subscription from Subscriptions.
`StatusCode[]`	`removeSubscriptions(Subscription[] subscriptions)` Remove subscriptions from Subscriptions.
`AsyncResult<StatusCode[]>`	`removeSubscriptionsAsync(Subscription... subscriptions)` Remove subscriptions from Subscriptions, asynchronously.
`void`	`resetEndpoint()` Undefines the Endpoint.
`protected void`	`resetPublishRequestSetpoint()` Resets the setpoint
`protected void`	`resetSubscriptionsAfterRemove(Subscription[] subscriptions, StatusCode[] result)`
`protected UaAddress`	`resolveConnectionAddress(UaAddress connectionAddress, EndpointDescription discoveredEndpoint)` This method is used to resolve the connection address that is used to form the socket connection to the "actual endpoint" after Discovery has been done (to `getAddress()`).
`<T extends ServiceResponse> T`	`serviceRequest(ServiceRequest<T> request)` Send a custom service request to the server, synchronously.
`<T extends ServiceResponse> AsyncResult<T>`	`serviceRequestAsync(ServiceRequest<T> request)` Send a custom service request to the server, asynchronously.
`<T extends ServiceResponse> T`	`sessionlessRequest(ServiceRequest<T> request)` Make a service request to the server over a secure channel.
`void`	`setAddress(String address)` Define the connection address of the OPC UA server as a string.
`void`	`setAddress(UaAddress address)` Define the connection address to the OPC UA server.
`void`	`setApplicationIdentity(ApplicationIdentity applicationIdentity)` Set the security identity of the client application.
`void`	`setAuditEntryId(String auditEntryId)` An identifier that identifies the Client's security audit log entry associated with the operations requested from the server.
`void`	`setAutoReconnect(boolean doAutoReconnect)` Define automatic reconnection.
`void`	`setConnectTimeout(int connectionTimeoutMilliseconds)` Set initial connection timeout in milliseconds.
`void`	`setConnectTimeout(int value, TimeUnit timeUnit)` Convenience method for `#setConnectionTimeout(long)` taking specific time units.
`void`	`setDefaultMaxAge(double defaultMaxAge)` Set the default maxAge parameter to be used in Read calls when none is specified in the method signature.
`static void`	`setDefaultProtocol(UaApplication.Protocol defaultProtocol)` The default protocol to use for URI, if none is defined in #setUri()
`void`	`setDefaultTimestampsToReturn(TimestampsToReturn defaultTimestampsToReturn)` Set the default TimestampsToReturn parameter to be used in Read calls when none is specified in the method signature.
`void`	`setEndpoint(EndpointDescription endpoint)` Use the EndpointDescription to select the server endpoint to connect to.
`protected void`	`setHttpsSecurityPolicies(HttpsSecurityPolicy[] httpsSecurityPolicies)` The TLS security policies used for HTTPS communications.
`void`	`setInitTypeDictionaryAutoUsage(boolean initTypeDictionaryAutoUsage)` Controls if `TypeDictionary` is initialized automatically, when custom Structures are encountered for the first time.
`void`	`setInitTypeDictionaryOnConnect(boolean initTypeDictionaryOnConnect)` Controls if `TypeDictionary` is initialized automatically after `connect()`.
`void`	`setInitTypeDictionaryShallow(boolean initTypeDictionaryShallow)` If set to true, `TypeDictionary` will consider it as initialized if it would be initialized, but doesn't do any of the normal initialization procedures, such as reading the types of the server.
`void`	`setKeepSubscriptions(boolean keepSubscriptions)` Defines that the Subscriptions should be left in the server, when {link disconnect} is called.
`void`	`setListener(UaClientListener listener)` Define the ClientListener to get notifications of client events.
`void`	`setLocale(Locale locale)` Define the user locale, in which all localizable text is requested from the server.
`void`	`setMaxResponseMessageSize(int maxResponseMessageSize)` Define the maximum size, in bytes, for the body of any response message from the server.
`void`	`setMaxResponseMessageSize(UnsignedInteger maxResponseMessageSize)` Define the maximum size, in bytes, for the body of any response message from the server.
`void`	`setOperationDiagnosticMask(EnumSet<UaApplication.DiagnosticMask> operationDiagnosticMask)` Define the operational level diagnostic info to return for the service calls.
`void`	`setPublishRequestFactor(double publishRequestFactor)` The factor is used to calculate the number of pending publish requests we are trying to keep open in the server all the time.
`void`	`setPublishRequestSetpoint(int publishRequestSetpoint)` Define the target number of PublishRequests to send to the server.
`void`	`setPublishRequestTimeout(long publishRequestTimeout)` Define the timeout used for PublishRequests.
`void`	`setPublishRequestTimeout(long publishRequestTimeout, TimeUnit timeUnit)` /** Define the timeout used for PublishRequests using a specific TimeUnit.
`void`	`setPublishRequestTimeout(UnsignedInteger publishRequestTimeout)` Define the timeout used for PublishRequests.
`void`	`setReverseAddress(UaAddress clientListenAddress)` Defines a client-side socket address for an OPC UA Reverse Connection.
`void`	`setReverseConnectionListener(ReverseConnectionListener reverseConnectionListener)` Set a reverse connection listener that can be used to validate that the incoming calls are coming from an expected server.
`void`	`setReversePort(int port)` Convenience method for defining the Reverse Connection with a specific port number on every network interface.
`void`	`setSecurityMode(SecurityMode securityMode)` Define the security mode to connect to.
`void`	`setServiceDiagnosticMask(EnumSet<UaApplication.DiagnosticMask> serviceDiagnosticMask)` Define the service level diagnostic info to return for the service calls.
`void`	`setSessionName(String sessionName)` Define a name for the session.
`void`	`setSessionTimeout(double sessionTimeout)` Set the requested session timeout.
`void`	`setSessionTimeout(long sessionTimeout, TimeUnit timeUnit)`
`void`	`setSocketFactory(TcpConnection.SocketFactory socketFactory)` This can be used to override the `TcpConnection.DefaultSocketFactory` used by `TcpConnection.getSocketFactory()` for opc.tcp connections (during `connect()`) reverse connections).
`void`	`setStatusCheckInterval(long statusCheckInterval)` Define the status check interval, that is, how often the server status is read, when isConnected.
`void`	`setStatusCheckInterval(long statusCheckInterval, TimeUnit timeUnit)`
`void`	`setStatusCheckTimeout(long statusCheckTimeout)` Define the timeout to use for Server Status reads in `updateServerStatus()`.
`void`	`setStatusCheckTimeout(long statusCheckTimeout, TimeUnit timeUnit)`
`void`	`setTimeout(long timeOut)` Define the default communication request timeout.
`void`	`setTimeout(long timeOut, TimeUnit timeUnits)` Define the default communication request timeout.
`void`	`setTimeout(UnsignedInteger timeOut)` Define the default communication request timeout.
`void`	`setUri(String uri)` Deprecated. use `setAddress(String)` instead.
`static void`	`setUseCommErrorCodes(boolean communicationErrorFilteringEnabled)` Defines whether `getCommErrorCodes()` are used to indicate communication errors that trigger reconnect.
`void`	`setUserIdentity(UserIdentity userIdentity)` Define a new user identity.
`void`	`setValidateCreateSessionResponseCert(boolean validateCreateSessionResponseCert)` Define whether the certificate received in CreateSessionResponse is validated to be the same as used to create the SecureChannel.
`void`	`setValidateDiscoveredEndpoints(boolean validateDiscoveredEndpoints)` Define whether endpoints discovered from the server are validated against the endpoints returned for a session create request.
`void`	`setValidateNonceLength(boolean validateNonceLength)` Define whether the length of Nonces received from the server are validated.
`void`	`updateServerStatus()` Read the current server status.
`protected <T extends ServiceResponse> void`	`validateServiceRequest(ServiceRequest<T> request)` This method is called before any `ServiceRequest` is sent to the server (during a Session).
`WriteResponse`	`write(WriteValue... nodesToWrite)` Write values to the server.
`AsyncResult<WriteResponse>`	`writeAsync(WriteValue... nodesToWrite)` Write node attributes to the server asynchronously.
`boolean`	`writeAttribute(ExpandedNodeId nodeId, UnsignedInteger attributeId, Object value)` Write a single attribute value.
`boolean`	`writeAttribute(ExpandedNodeId nodeId, UnsignedInteger attributeId, Object value, boolean autoConvert)` Write a single attribute value.
`boolean`	`writeAttribute(ExpandedNodeId nodeId, UnsignedInteger attributeId, Object value, NumericRange indexRange)` Write a single attribute value.
`boolean`	`writeAttribute(NodeId nodeId, UnsignedInteger attributeId, Object value)` Write a single attribute value.
`boolean`	`writeAttribute(NodeId nodeId, UnsignedInteger attributeId, Object value, boolean autoConvert)` Write a single attribute value.
`boolean`	`writeAttribute(NodeId nodeId, UnsignedInteger attributeId, Object value, NumericRange indexRange)` Write a single attribute value.
`boolean`	`writeAttribute(UaNodeId nodeId, UnsignedInteger attributeId, Object value)` Write a single attribute value.
`boolean`	`writeAttribute(UaNodeId nodeId, UnsignedInteger attributeId, Object value, boolean autoConvert)` Write a single attribute value.
`boolean`	`writeAttribute(UaNodeId nodeId, UnsignedInteger attributeId, Object value, NumericRange indexRange)` Write a single attribute value.
`boolean`	`writeValue(ExpandedNodeId nodeId, Object value)` Write the value attribute of a node.
`boolean`	`writeValue(ExpandedNodeId nodeId, Object value, boolean autoConvert)` Write the value attribute of a node.
`boolean`	`writeValue(ExpandedNodeId nodeId, Object value, NumericRange indexRange)` Write the value attribute of a node.
`boolean`	`writeValue(NodeId nodeId, Object value)` Write the value attribute of a node.
`boolean`	`writeValue(NodeId nodeId, Object value, boolean autoConvert)` Write the value attribute of a node.
`boolean`	`writeValue(NodeId nodeId, Object value, NumericRange indexRange)` Write the value attribute of a node.
`boolean`	`writeValue(UaNodeId nodeId, Object value)` Write the value attribute of a node.
`boolean`	`writeValue(UaNodeId nodeId, Object value, boolean autoConvert)` Write the value attribute of a node.
`boolean`	`writeValue(UaNodeId nodeId, Object value, NumericRange indexRange)` Write the value attribute of a node.
`StatusCode[]`	`writeValues(ExpandedNodeId[] nodeIds, Object[] value)` Write the value attribute of several nodes at once.
`StatusCode[]`	`writeValues(ExpandedNodeId[] nodeIds, Object[] values, NumericRange[] indexRanges)` Write the value attribute of several nodes at once.
`StatusCode[]`	`writeValues(NodeId[] nodeIds, Object[] value)` Write the value attribute of several nodes at once.
`StatusCode[]`	`writeValues(NodeId[] nodeIds, Object[] values, NumericRange[] indexRanges)` Write the value attribute of several nodes at once.
`StatusCode[]`	`writeValues(UaNodeId[] nodeIds, Object[] value)` Write the value attribute of several nodes at once.
`StatusCode[]`	`writeValues(UaNodeId[] nodeIds, Object[] values, NumericRange[] indexRanges)` Write the value attribute of several nodes at once.

Methods inherited from class com.prosysopc.ua.UaApplication
formatUri, getAggregateCalculator, getCertificateValidator, getKnownDataTypeDictionary, getOperationLimits, getRegisteredClasses, getSdkVersion, getVersion, isAutoDiscoverCodegenModels, registerAutoDiscoveredModels, registerModelInternal, setAutoDiscoverCodegenModels, setCertificateValidator, setOperationLimits, validateApplicationCertificate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- MAX_CACHE_AGE
```
public static final Double MAX_CACHE_AGE
```
  Maximum possible value for setDefaultMaxAge(double), based on the Read service call definitions.

Constructor Detail
- UaClient
```
public UaClient()
```
  Create a new server connection. Remember to specify the server connection address via setAddress(UaAddress) as well as the ApplicationIdentity via setApplicationIdentity(ApplicationIdentity) before calling connect(). For reverse connections, use setReversePort(int) (or setReverseAddress(UaAddress)) instead of setAddress(UaAddress).
  
  See Also:
  
  setAddress(UaAddress), setReverseAddress(UaAddress), setApplicationIdentity(ApplicationIdentity)
- UaClient
```
public UaClient(String address)
```
  Create a server connection using the given server connection address. Remember to specify the ApplicationIdentity before calling connect().
  
  Parameters:
  
  address - the connection address for the server.
  
  Throws:
  
  IllegalArgumentException - if the address is not valid.
  
  See Also:
  
  setAddress(UaAddress), setReverseAddress(UaAddress), setApplicationIdentity(ApplicationIdentity)
- UaClient
```
public UaClient(UaAddress address)
```
  Create a server connection using the given server connection address. Remember to specify the ApplicationIdentity before calling connect().
  
  Parameters:
  
  address - the connection address for the server.

Method Detail

getCommErrorCodes
```
public static Set<StatusCode> getCommErrorCodes()
```
Returns a Set of StatusCodes that indicate a communication error between the Client and the Server when checking Server status and communication error filtering has been enabled with setCommunicationErrorFilteringEnabled or when handling PublishResponse errors.
If communication error filtering hasn't been enabled, then all Bad and Uncertain StatusCodes will indicate a communication error between the Client and the Server when reading Server status.

getDefaultProtocol
```
public static UaApplication.Protocol getDefaultProtocol()
```
The default protocol to use for URI, if none is defined in #setUri()

Returns:

the defaultProtocol

isUseCommErrorCodes
```
public static boolean isUseCommErrorCodes()
```
Returns value set to setUseCommErrorCodes(boolean).

setDefaultProtocol
```
public static void setDefaultProtocol(UaApplication.Protocol defaultProtocol)
```
The default protocol to use for URI, if none is defined in #setUri()

Parameters:

defaultProtocol - the defaultProtocol to set

setUseCommErrorCodes
```
public static void setUseCommErrorCodes(boolean communicationErrorFilteringEnabled)
```
Defines whether getCommErrorCodes() are used to indicate communication errors that trigger reconnect. If set to false all non-Good StatusCodes in status check are considered as an indication of communication error between the Client and the Server. If set to true only the codes in the getCommErrorCodes() are treated as communication errors. Default: false.

addServerStatusListener
```
public void addServerStatusListener(ServerStatusListener serverStatusListener)
```
Add a new listener for the ServerStatus events. If hasServerStatusListener(ServerStatusListener), the listener is not added again.

Parameters:

serverStatusListener - the listener object

addSubscription
```
public Subscription addSubscription(Subscription subscription)
                             throws ServiceException,
                                    StatusException
```
Create a new subscription and add it to Subscriptions. If we are Connected to the server, the subscription is also added to the server. Otherwise, it will be added, when you connect() to the server.
The server will assign an ID for each subscription.
Even if the createSubscription call fails, the subscription will still be added to the client object and it will be in getSubscriptions().
If the subscription belongs to another client, it will be moved to this client.

Parameters:

subscription - The subscription to add.

Returns:

the subscription The added subscription (the same object)

Throws:

ServiceException - if the server returns an error for a service call

StatusException - if the subscription was being transferred from another server session, but it failed.

See Also:

getSubscription(int), getSubscriptionCount(), removeSubscription(com.prosysopc.ua.client.Subscription)

call
```
public CallResponse call(CallMethodRequest... MethodsToCall)
                  throws ServiceException
```
Call several methods at once. Use this method, instead of the other call(NodeId, NodeId, Variant...) to call several methods at once to reduce the payload required for making the calls.

Parameters:

MethodsToCall - The method call structures.

Returns:

The response message. Read the Results and DiagnosticInfo for each call.

Throws:

ServiceException

See Also:

callAsync(com.prosysopc.ua.stack.core.CallMethodRequest...)

call
```
public Variant[] call(NodeId objectId,
                      NodeId methodId,
                      Variant... inputArguments)
               throws ServiceException,
                      MethodCallStatusException
```
Call a method in the server. Use call(CallMethodRequest...) instead if you need to call several methods at the same time.

Parameters:

objectId - The NodeId of the Object or ObjectType that is the source of a HasComponent Reference (or subtype of HasComponent Reference) to the Method.

methodId - NodeId of the Method to invoke in the object.

inputArguments - List of input argument values. An empty list indicates that there are no input arguments. The size and order of this list matches the size and order of the input arguments defined by the input InputArguments Property of the Method.
The name, a description and the data type of each argument are defined by the Argument structure in each element of the method node's InputArguments Property.

Returns:

The OutputArguments of the method result.

Throws:

ServiceException - if the method call fails

MethodCallStatusException - if the method returns a bad StatusCode.
The StatusCode is Bad_InvalidArgument, if at least one input argument broke a constraint (e.g. wrong data type, value out of range). Read the InputArgumentResults of the exception to learn which one was not correct.
If the Method execution failed in the server, the StatusCode is set accordingly.

callAsync
```
public AsyncResult<CallResponse> callAsync(CallMethodRequest... methodsToCall)
```
Call several methods asynchronously.

Parameters:

methodsToCall - The method call structures.

Returns:

The asynchronous monitor, which will provide the response, when available (as CallResponse). You can poll it, set a listener or wait for the result (or error).

See Also:

call(com.prosysopc.ua.stack.core.CallMethodRequest...)

connect
```
public void connect()
             throws ServiceException,
                    ConnectException,
                    SessionActivationException,
                    InvalidServerEndpointException
```
Connect to the OPC UA server.
Connects to the server at connection address defined by getAddress() or starts listening to a reverse connection from a server by opening a socket at getReverseAddress(), if that is defined.
setApplicationIdentity(ApplicationIdentity) must also be called before the connection is made.
The connection procedure starts by calling discoverEndpoints() and then selecting a suitable EndpointDescription, based on the connection address and security settings. getAddress() does not need to match exactly to an endpointUrl of the selected Endpoint.
Note that you can also use #setEndpoint() yourself to initialize the Endpoint as well.
Once the endpoint is defined, the method will create a new OPC UA SecureChannel and a new OPC UA session using the certificates defined in the ApplicationIdentity, and finally the session is activated using the defined UserIdentity.
If there are Subscriptions already defined, they will be created in the server as well after the session has been established. If the subscriptions still exist in the server, they will be transferred to the new session.
NOTE! After this method has succeeded (i.e. not thrown), it shouldn't be called again until disconnect(). However, it can be called again, but it does nothing. If connection breaks, by default SDK handles reconnections. If isAutoReconnect() is set to false (default true), reconnections must be handled with reconnect() (not with connect()).

Throws:

ServiceException - if there are service call errors while discovering the endpoints or adding the subscriptions to the server. Note that all the exceptions below are also subclasses of ServiceException.

ConnectException - if the connection fails

SessionActivationException - if the session cannot be activated with the UserIdentity

InvalidServerEndpointException - If the server endpoint defined by the parameters is not found from the servers list of supported endpoints

disconnect
```
public void disconnect()
```
Disconnect from the server.
The method closes the session to the server and disconnects the communication channel.
Use setKeepSubscriptions(boolean) to define, if the subscriptions should be kept in the the server, after disconnect (in case you wish to have them available when you reconnect, for example).
The method uses a default timeout of 60000 ms (1 minute) for the CloseSession call.

disconnect
```
public void disconnect(long timeout)
```
Disconnect from the server.
The method closes the session to the server and disconnects the communication channel.
Use setKeepSubscriptions(boolean) to define, if the subscriptions should be kept in the the server, after disconnect (in case you wish to have them available when you reconnect, for example).

Parameters:

timeout - timeout (in milliseconds) for the CloseSession call. Must be a positive value. 0 tells it to wait infinitely for a response.

disconnect

public void disconnect(long timeout,
                       TimeUnit timeUnit)

See Also:: disconnect(long)

disconnect
```
public void disconnect(UnsignedInteger timeout)
```
Disconnect from the server.
The method closes the session to the server and disconnects the communication channel.
Use setKeepSubscriptions(boolean) to define, if the subscriptions should be kept in the the server, after disconnect (in case you wish to have them available when you reconnect, for example).

Parameters:

timeout - timeout (in milliseconds) for the CloseSession call. UnsignedInteger.ZERO tells it to wait infinitely for a response.

discoverEndpoints
```
public EndpointDescription[] discoverEndpoints()
                                        throws InvalidServerEndpointException,
                                               ConnectException,
                                               ServiceException
```
Find the list of server end-points corresponding to getProtocol().

Returns:

list of end-points supported by the server at URI.

Throws:

InvalidServerEndpointException - if the URI is not valid.

ConnectException - if the list could not be retrieved - probably because the server could not be connected to.

ServiceException - if the service call fails

discoverEndpoints
```
public EndpointDescription[] discoverEndpoints(UaApplication.Protocol... protocols)
                                        throws InvalidServerEndpointException,
                                               ConnectException,
                                               ServiceException
```
Find the list of server end-points corresponding to the defined protocols.

Parameters:

protocols - the transport protocols for which the endpoints are requested. If omitted, getProtocol() is used.

Returns:

list of end-points supported by the server at URI.

Throws:

InvalidServerEndpointException - if the URI is not valid.

ConnectException - if the list could not be retrieved - probably because the server could not be connected to.

ServiceException - if the service call fails

getActualOperationLimits
```
public OperationLimits getActualOperationLimits()
```
Returns the actual operation limits i.e. the minimum of client and server limits calculated during connect, before that returns same as UaApplication.getOperationLimits().

getActualPublishRequestSetpoint
```
public int getActualPublishRequestSetpoint()
```
Returns:

the actual setpoint for PublishRequests, either calculated or adjusted in case the server sent Bad_TooManyPublishRequests

See Also:

getPublishRequestSetpoint()

getAddress
```
public UaAddress getAddress()
```
Returns the connection address of the OPC UA server. The address is used at connect(), except when isInReverseMode(), in which case getReverseAddress() is used instead.

See Also:

setAddress(UaAddress), setReverseAddress(UaAddress), connect()

getAddressSpace
```
public AddressSpace getAddressSpace()
```
AddressSpace object used for browsing the addres space of the server and for using the View services.

Specified by:

getAddressSpace in class UaApplication

Returns:

The address space interface to the server

getApplicationIdentity
```
public ApplicationIdentity getApplicationIdentity()
```
The identity information of your OPC UA client application.

Specified by:

getApplicationIdentity in class UaApplication

Returns:

the current identity of the client application. Use setApplicationIdentity(com.prosysopc.ua.ApplicationIdentity) to define it, before connecting to the server.

getAuditEntryId
```
public String getAuditEntryId()
```
Audit entry to include in service calls. The server can use the information to log audit entries, so that you can later track which application did what.

Returns:

the auditEntryId the ID to include in every service call.

getConnectTimeout
```
public int getConnectTimeout()
```
Connection timeout in milliseconds. By default 60 seconds, i.e. 60000.

getDefaultMaxAge
```
public double getDefaultMaxAge()
```
Get the default maxAge parameter used in Reads when none specified.

See Also:

setDefaultMaxAge(double)

getDefaultTimestampsToReturn
```
public TimestampsToReturn getDefaultTimestampsToReturn()
```
Get the default timestampsToReturn parameter used in Reads when none is specified

See Also:

setDefaultTimestampsToReturn(TimestampsToReturn)

getEncoderContext
```
public EncoderContext getEncoderContext()
```
Specified by:

getEncoderContext in class UaApplication

Returns:

the encoder context, which is used for mapping namespaces and nodeIds in the stack layer.

getEndpoint
```
public EndpointDescription getEndpoint()
```
The server endpoint that is used.
The endpoint is available only when hasConnected().

Returns:

the endpoint or null, if no endpoint is in use.

getEndpointConfiguration

public EndpointConfiguration getEndpointConfiguration()

Configuration parameters for the channel and endpoint. The settings are used when connect() is called. So if you change them after that they will have no effect, unless you reconnect.

The parameters of the structure are:

Type	Parameter	Default value	Description
Integer	OperationTimeout	120000 (2 min)	Default timeout used by the stack, if the request messages do not define any. It is recommended to use `setTimeout(long)`, instead of setting the timeout here, though. It will define the timeout also in the messages.
Boolean	UseBinaryEncoding	true	Binary encoding should be used always.
Integer	MaxStringLength	UnsignedShort.MAX_VALUE	Maximum length for string parameters in service calls.
Integer	MaxByteStringLength	UnsignedShort.MAX_VALUE*16	Maximum length for byte array parameters in service calls.
Integer	MaxArrayLength	UnsignedShort.MAX_VALUE	Maximum length for normal array parameters in service calls.
Integer	MaxMessageSize	UnsignedShort.MAX_VALUE*64	Maximum length for service call messages.
Integer	MaxBufferSize	UnsignedShort.MAX_VALUE	Maximum buffer size to use in service calls.
Integer	ChannelLifetime	120000 (2 min)	The lifetime of the channel. This specifies how long the server will keep the channel open, in case it does not receive any requests from the client.
Integer	SecurityTokenLifetime	3600000 (1 hour)	The requested lifetime, in milliseconds, for security tokens. It specifies how often the client will renew the security token.

Returns:: the current endpointConfiguration

getHost
```
@Deprecated
public String getHost()
```
Deprecated. use getAddress() and UaAddress.getHost()

Returns:

the host computer to connect to / to which we are connected.

getHttpsSettings
```
public HttpsSettings getHttpsSettings()
```
Returns:

the HTTPS settings of the connection.

getLastOperationDiagnostics
```
public DiagnosticInfo[] getLastOperationDiagnostics()
```
The operation level diagnostic information related to the last service call.
Use setOperationDiagnosticMask to define which operation level diagnostic information you wish to receive with the service calls. If you suspect that the results contain diagnostics, check this array after the service call.
Note that if you perform parallel service calls, they must be synchronized so that you get the lastOperationDiagnostics for the previous call. Or use alternative calls, such as 'read', which return the diagnostics as part of the service result.

Returns:

the array of diagnostic information for the last service call or null, if none was returned

See Also:

getLastServiceResult(), getLastServiceDiagnostics(), getLastResponseTimestamp()

getLastResponseTimestamp
```
public DateTime getLastResponseTimestamp()
```
The timestamps of the response message of the last service call.

Returns:

the timestamp of the last response message.

See Also:

getLastServiceResult(), getLastServiceDiagnostics(), getLastOperationDiagnostics()

getLastServiceDiagnostics
```
public DiagnosticInfo getLastServiceDiagnostics()
```
The service level diagnostic information related to the last service call.
Use setServiceDiagnosticMask to define which service level diagnostics you wish to receive with the service calls. If you suspect that the results contain diagnostics, check this value after the service call.
Note that if you perform parallel service calls, they must be synchronized so that you get the lastServiceDiagnostics for the previous call. Or use alternative calls, such as 'read', which return the diagnostics as part of the service result.
If a service fails due to a bad ServiceResult, you can read the diagnostics to check if the server provide is additional information about the problem.

Returns:

the service level diagnostic information for the last service call or null, if none was returned

See Also:

getLastOperationDiagnostics(), getLastServiceResult(), getLastResponseTimestamp()

getLastServiceResult
```
public StatusCode getLastServiceResult()
```
Returns:

the lastServiceResult the service result of the last service call

See Also:

getLastOperationDiagnostics(), getLastServiceDiagnostics(), getLastResponseTimestamp()

getListener
```
public UaClientListener getListener()
```
Returns:

the listener

getLocale
```
public Locale getLocale()
```
The currently defined user locale. The server should return all localizble information in this locale.

Returns:

the requested user locale

getMaxResponseMessageSize
```
public UnsignedInteger getMaxResponseMessageSize()
```
Returns:

the maximum size of any response message allowed for the server. Default is 0, which means that it is not used.

getNamespaceTable
```
public NamespaceTable getNamespaceTable()
```
The server NamespaceTable. Use the NamespaceTable to convert between NodeId and ExpandedNodeId and to find the list of namespaces that the server uses.
The table is requested from the server (from NodeId Server_NamespaceArray) when first accessed. Otherwise, it is returned from the cache. Use getNamespaceTable(boolean) to force a refresh.

Overrides:

getNamespaceTable in class UaApplication

Returns:

the namespaceTable

getNamespaceTable
```
public NamespaceTable getNamespaceTable(boolean forceRefresh)
                                 throws ServiceException,
                                        StatusException
```
The server NamespaceTable. Use the NamespaceTable to convert between NodeId and ExpandedNodeId and to find the list of namespaces that the server uses.
The table is requested from the server (from NodeId Server_NamespaceArray) when first accessed. It is available only when isConnected is true.

Parameters:

forceRefresh - request that the array is refreshed from the server, even if it has been read already

Returns:

the namespaceTable

Throws:

StatusException - if the namespace array read from the server is not valid

ServiceException - if the namespace array could not be read

getOperationDiagnosticMask
```
public EnumSet<UaApplication.DiagnosticMask> getOperationDiagnosticMask()
```
The currently requested operation diagnostics.

Returns:

requested the operation diagnostics.

getPort
```
@Deprecated
public int getPort()
```
Deprecated. use getAddress() and UaAddress.getPort()

Returns:

the TCP port of the server to connect to / to which we are connected

getProtocol
```
@Deprecated
public UaApplication.Protocol getProtocol()
```
Deprecated. use getAddress() and UaAddress.getProtocol()

Returns:

the communication protocol to use with the server

getPublishRequestFactor
```
public double getPublishRequestFactor()
```
Returns:

The publish request factor to use when determining the number of publish requests to send to the server.

See Also:

setPublishRequestFactor(double)

getPublishRequestSetpoint
```
public int getPublishRequestSetpoint()
```
The current target of PublishRequests to send to the server. If the setpoint is 0, getActualPublishRequestSetpoint() is actually calculated based on getPublishRequestFactor() and getSubscriptionCount() and automatically adjusted, if the server sends Bad_TooManyPublishRequest errors for the PublishRequests.

Returns:

the current publishRequestSetpoint (Default is 0, indicating that the getPublishRequestFactor() should be used)

See Also:

getActualPublishRequestSetpoint(), setPublishRequestSetpoint(int)

getPublishRequestTimeout
```
public UnsignedInteger getPublishRequestTimeout()
```
Returns:

timeout used for PublishRequests

getReverseAddress
```
public UaAddress getReverseAddress()
```
See Also:

setReverseAddress(UaAddress)

getReverseConnectionListener
```
public ReverseConnectionListener getReverseConnectionListener()
```
See Also:

setReverseConnectionListener(ReverseConnectionListener).

getSecureChannel

public SecureChannel getSecureChannel()
                               throws ServerConnectionException

Throws:: ServerConnectionException

getSecurityMode
```
public SecurityMode getSecurityMode()
```
Returns:

the current security mode used in communications.

getServerIdentity
```
public ApplicationIdentity getServerIdentity()
```
Returns:

the identity information for the server application. This is only available when isConnected.

getServerName
```
@Deprecated
public String getServerName()
```
Deprecated. use getAddress() and UaAddress.getServerName()

Returns:

the server name part of the server URI.

getServerState
```
public ServerState getServerState()
```
The current state of the server.
If communication fails, hasConnected() will still return true, but getServerState() will give ServerState.CommunicationFault.
If isAutoReconnect() is true, communication failures will be recovered automatically. Otherwise, you must call reconnect yourself, until it succeeds.

Returns:

the current state of the server. Equals to getServerStatus().getState(), when status is available; ServerState.CommunicationFault, when the status could not be read because of a communication problem; ServerState.Unknown when not hasConnected() or if status could not be read for some other reason.

getServerStatus
```
public ServerStatusDataType getServerStatus()
                                     throws StatusException,
                                            ServerConnectionException
```
The status of the server that we are connected. The status is updated every statusCheckInterval. Whenever it changes, you get a StatusChange event, which you can listen to. Or you can listen to StateChange, which is called whenever the server state changes.
Note that the status is only available when the client hasConnected().
Note also that getServerState() returns the State part of the status - also when the status cannot be read, so it is easier to use for plain state checking.

Returns:

The current server status

Throws:

StatusException - if the server status could not be read from the server. Read the StatusCode of the exception to learn the reason for that. The same status is also available from ServerStatusError

ServerConnectionException - if we are not connected to the server, in which case the status is not available

See Also:

getServerTimeDifference()

getServerStatusError
```
public StatusCode getServerStatusError()
```
In case the monitoring of Server Status fails, the related error code is available from here. The respective exception is also raised, if you try to read the ServerStatus when the error is defined.

Returns:

The last status of the serverStatus read operation.

getServerTable
```
public ServerTable getServerTable()
```
Description copied from class: UaApplication

Returns the server's ServerTable (from node VariableIdentifiers.Server_ServerArray). The indexes of the table are used if References of a node in the server points to another server via ExpandedNodeId.getServerIndex(). The index 0 always means the local server and has the local server's ApplicationUri

Specified by:

getServerTable in class UaApplication

getServerTable
```
public ServerTable getServerTable(boolean forceRefresh)
                           throws ServiceException,
                                  StatusException
```
The server ServerTable. Use the ServerTable to find the list of servers that the server uses.
The table is requested from the server (from NodeId Server_ServerArray) when first accessed. It is available only when isConnected is true.

Parameters:

forceRefresh - request that the array is refreshed from the server, even if it has been read already

Returns:

the serverTable

Throws:

StatusException - if the server array read from the server is not valid

ServiceException - if the server array could not be read

getServerTimeDifference
```
public long getServerTimeDifference()
```
The current time difference between the server and the client. The value is calculated from the value returned by the server for the ServerStatus.CurrentTime and comparing it to the current system time in the client. It can tell you the lag between the server and client communications, if the applications have synchronized clocks, or the difference between the clocks, if they are not synchronized.

Returns:

The current difference in time of the server and the client clock plus the communication delay. Or 0, if ServerStatus is not available.

See Also:

getServerStatus()

getServiceDiagnosticMask
```
public EnumSet<UaApplication.DiagnosticMask> getServiceDiagnosticMask()
```
Returns:

The currently defined set of Service Diagnostics to get from the server for each service call.

getSession
```
public Session getSession()
```
The current session.
Session is available when isConnected. Otherwise it will be null.

Returns:

The current session or null if not isConnected.

getSessionName
```
public String getSessionName()
```
Returns:

the user defined session name. If the value is null, UAClient will autogenerate a new identifier at each connection. The currently used session name is part of the session information, available from getSession().

getSessionTimeout
```
public double getSessionTimeout()
```
Returns:

the requested SessionTimeout. The value will be revised by the server when you connect(). The revised value can be checked from the current session, available from getSession().

getSocketFactory
```
public TcpConnection.SocketFactory getSocketFactory()
```
Returns the TcpConnection.SocketFactory previously set via #setSocketFactory(SocketFactory).

getStatusCheckInterval
```
public long getStatusCheckInterval()
```
Returns:

The current status check interval (in ms). Default is 1000 ms.

getStatusCheckTimeout
```
public long getStatusCheckTimeout()
```
The timeout used for Server Status reads in updateServerStatus()

Returns:

the statusCheckTimeout (in milliseconds)

See Also:

getStatusCheckInterval()

getSubscription
```
public Subscription getSubscription(int index)
```
Get a subscription by index.

Returns:

the subscription at index

See Also:

getSubscriptionCount(), addSubscription(com.prosysopc.ua.client.Subscription), removeSubscription(com.prosysopc.ua.client.Subscription), getSubscriptionById(UnsignedInteger), getSubscriptions()

getSubscriptionById
```
public Subscription getSubscriptionById(UnsignedInteger subscriptionId)
```
Get a subscription with the subscription ID specified by the server.

Parameters:

subscriptionId - the ID of the subscription

Returns:

the subscription

See Also:

getSubscriptionCount(), addSubscription(com.prosysopc.ua.client.Subscription), removeSubscription(com.prosysopc.ua.client.Subscription), getSubscription(int)

getSubscriptionCount
```
public int getSubscriptionCount()
```
Number of defined subscriptions.

Returns:

the number of subscription

See Also:

getSubscription(int), addSubscription(com.prosysopc.ua.client.Subscription), removeSubscription(com.prosysopc.ua.client.Subscription), getSubscriptions()

getSubscriptions
```
public Subscription[] getSubscriptions()
```
Get subscriptions.

Returns:

the subscriptions

See Also:

getSubscriptionCount(), addSubscription(com.prosysopc.ua.client.Subscription), removeSubscription(com.prosysopc.ua.client.Subscription), getSubscriptionById(UnsignedInteger), getSubscription(int)

getSupportedSecurityModes

public List<SecurityMode> getSupportedSecurityModes()
                                             throws InvalidServerEndpointException,
                                                    ServerConnectionException,
                                                    ServiceException

Get a list of security modes supported by the server. The security modes are defined by the endpoints returned by discoverEndpoints. Only the endpoints matching URI are accepted.

Returns:: the security modes
Throws:: ServiceException; ServerConnectionException; InvalidServerEndpointException

getSupportedUserIdentityTokens
```
public UserTokenPolicy[] getSupportedUserIdentityTokens()
                                                 throws ServerConnectionException,
                                                        ServiceException
```
Find out the user identity types supported by the server.
Note that this is available only after connect, as it retrieves the tokens supported by the selected server endpoint.

Returns:

the tokens supported by the server we are connected to.

Throws:

ServiceException - if the service call fails

ServerConnectionException

getTimeout
```
public int getTimeout()
```
The default communication request timeout. The timeout (in milliseconds) is used for every service request as a hint to the server, but also to define how long we will wait for the response message. If the response takes longer, a ServiceException(Bad_Timeout) is thrown.
The default value -1 indicates that the OperationTimeout defined by getEndpointConfiguration() should be used.

getTypeDictionary
```
public TypeDictionary getTypeDictionary()
```
Returns a TypeDictionary that can be used to parse unknown Structures.

getUri
```
@Deprecated
public String getUri()
```
Deprecated. use getAddress() and UaAddress.getAddress()

The server URI. The URI is composed of Protocol, Host, Port and ServerName. You can also set it using setUri(String) or alternatively with setEndpoint(EndpointDescription).

Returns:

the server URI

getUserIdentity
```
public UserIdentity getUserIdentity()
```
The current user identity to use for user authentication.

Returns:

the user identity used.

hasConnected
```
public boolean hasConnected()
```
Returns true if a successful connect() has happened (i.e. it didn't throw) and a subsequent disconnect() call hasn't finished, otherwise returns false.
In general for most applications this method can be used to determine if is there a need to call connect(). Once connect() succeeds, typically the SDK will manage the connection, depending on isAutoReconnect() (which is by default true).
This method should NOT be used for "do we have a connection to the server right now" type of questions, please see hasConnection() (do note the limitations).

hasConnection
```
public boolean hasConnection()
```
Best-effort answers to "Are we currently connected to the server?". In general whenever this method returns true there is a connection and when false there is not. However, note that this method is timing related, there is e.g. some delay when determining has a connection been broken due to timeouts and it is possible it is also recovered immediately after this method would have been called.
This method alone shouldn't be relied on e.g. when determining will a Read call work. When doing the calls the ServiceException and StatusException (or DataValue.getStatusCode() where applicable must be checked. However this method can be used e.g. for an UI that will poll this value periodically.
See also hasConnected().

hasServerStatusListener
```
public boolean hasServerStatusListener(ServerStatusListener serverStatusListener)
```
Check if the client already has the specified server status listener.

Parameters:

serverStatusListener - the listener to check

Returns:

true if the client has the listener

hasSubscription
```
public boolean hasSubscription(UnsignedInteger subscriptionId)
```
Checks if the client has a subscription with the specified ID.

Parameters:

subscriptionId - the ID of the subscription

Returns:

true, if the client has a subscription with ID

historyDeleteAtTimes

public HistoryUpdateResult historyDeleteAtTimes(NodeId nodeId,
                                                DateTime[] reqTimes)
                                         throws StatusException,
                                                ServerConnectionException,
                                                ServiceException

Deletes history at specified times.

Parameters:: nodeId - the NodeId of the node whose history should be deleted; reqTimes - an array of DateTimes at which history should be deleted
Returns:: the result of the operation as HistoryUpdateResult
Throws:: StatusException - if the operation fails; ServerConnectionException - if we are not connected to the server; ServiceException - if the service call fails

historyDeleteEvents

public HistoryUpdateResult historyDeleteEvents(NodeId nodeId,
                                               List<ByteString> eventIds)
                                        throws StatusException,
                                               ServerConnectionException,
                                               ServiceException

Deletes specified events from history.

Parameters:: nodeId - the NodeId of the node whose history should be deleted; eventIds - a list of eventIds (each id is a byte array) of the events that should be deleted
Returns:: the result of the operation as HistoryUpdateResult
Throws:: StatusException - if the operation fails; ServerConnectionException - if we are not connected to the server; ServiceException - if the service call fails

historyDeleteModified

public HistoryUpdateResult historyDeleteModified(NodeId nodeId,
                                                 DateTime startTime,
                                                 DateTime endTime)
                                          throws StatusException,
                                                 ServerConnectionException,
                                                 ServiceException

Deletes modified history from a specified interval.

Parameters:: nodeId - the NodeId of the node whose history should be deleted; startTime - the start of the interval to be deleted; endTime - the end of the interval to be deleted
Returns:: the result of the operation as HistoryUpdateResult
Throws:: StatusException - if the operation fails; ServerConnectionException - if we are not connected to the server; ServiceException - if the service call fails

historyDeleteRaw

public HistoryUpdateResult historyDeleteRaw(NodeId nodeId,
                                            DateTime startTime,
                                            DateTime endTime)
                                     throws StatusException,
                                            ServerConnectionException,
                                            ServiceException

Deletes raw history from a specified interval.

Parameters:: nodeId - the NodeId of the node whose history should be deleted; startTime - the start of the interval to be deleted; endTime - the end of the interval to be deleted
Returns:: the result of the operation as HistoryUpdateResult
Throws:: StatusException - if the operation fails; ServerConnectionException - if we are not connected to the server; ServiceException - if the service call fails

historyRead
```
public HistoryReadResult[] historyRead(HistoryReadDetails details,
                                       TimestampsToReturn timestampsToReturn,
                                       Boolean releaseContinuationPoints,
                                       HistoryReadValueId... nodesToRead)
                                throws ServerConnectionException,
                                       ServiceException
```
Read history of nodes.

Use this method to make a simultaneous read for several history values.
If the server cannot return all results in one response for any of the nodesToRead, it will define a continuation point in the respective HistoryReadResult. You can then make a subsequent history read request using the continuationPoint in the nodesToRead. If you do not wish to use the returned continuation points, make a new read with the same details and 'releaseContinuationPonts=true'.
You will need to be able to define a correct subtype of HistoryReadDetails for the call.
If you only need to read the history of one variable, you may wish to consider using one of the other historyReadXxx methods, which will do that for you. They will also take care of continuationPoint handling for you. The drawback is that they are only capable of reading one variable at a time.

Parameters:

details - specifies how the data should be read. Use one of the subclasses of HistoryReadDetails.

timestampsToReturn - defines which timestamp information should be returned. The parameter may not be TimestampsToReturn.Neither.

releaseContinuationPoints - if you do not want to use the continuation points returned by the previous request, define this parameter as true, to enable the server to release the continuation points that it reserved. Note though that when it is true, the server will not return any data, so in normal reads you must keep it false.

nodesToRead - The node data for which the history is requested. Define the continuationPoints here, if you wish to continue a previous request that returned continuationPoints.

Returns:

the history read results. If the results contain errors, you can examine the related diagnostic information from getLastOperationDiagnostics().

Throws:

ServerConnectionException - if not connected to the server

ServiceException - if the service call fails

IllegalArgumentException - if details cannot be encoded

See Also:

historyReadAsync(com.prosysopc.ua.stack.core.HistoryReadDetails, com.prosysopc.ua.stack.core.TimestampsToReturn, java.lang.Boolean, com.prosysopc.ua.stack.core.HistoryReadValueId...), historyReadAtTimes(com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.DateTime[], com.prosysopc.ua.stack.utils.NumericRange, com.prosysopc.ua.stack.core.TimestampsToReturn), historyReadEvents(com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, com.prosysopc.ua.stack.core.EventFilter, com.prosysopc.ua.stack.core.TimestampsToReturn), historyReadModified(com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, com.prosysopc.ua.stack.utils.NumericRange, com.prosysopc.ua.stack.core.TimestampsToReturn), historyReadProcessed(com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.DateTime, java.lang.Double, com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.core.AggregateConfiguration, com.prosysopc.ua.stack.utils.NumericRange, com.prosysopc.ua.stack.core.TimestampsToReturn), historyReadRaw(com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.DateTime, long, java.lang.Boolean, com.prosysopc.ua.stack.utils.NumericRange, com.prosysopc.ua.stack.core.TimestampsToReturn)

historyReadAsync
```
public AsyncResult<HistoryReadResponse> historyReadAsync(HistoryReadDetails details,
                                                         TimestampsToReturn timestampsToReturn,
                                                         Boolean releaseContinuationPoints,
                                                         HistoryReadValueId... nodesToRead)
```
Read history of nodes asynchronously.

Use this method to make a simultaneous read for several history values asynchronously.
If the server cannot return all results in one response for any of the nodesToRead, it will define a continuation point in the respective HistoryReadResult. You can then make a subsequent history read request using the continuationPoint in the nodesToRead. If you do not wish to use the returned continuation points, make a new read with the same details and 'releaseContinuationPonts=true'.
You will need to be able to define a correct subtype of HistoryReadDetails for the call.
If you only need to read the history of one variable, you may wish to consider using one of the other historyReadXxx methods, which will do that for you. They will also take care of continuationPoint handling for you. The drawback is that they are only capable of reading one variable at a time.

Parameters:

details - specifies how the data should be read. Use one of the subclasses of HistoryReadDetails.

timestampsToReturn - defines which timestamp information should be returned. The parameter may not be TimestampsToReturn.Neither.

releaseContinuationPoints - if you do not want to use the continuation points returned by the previous request, define this parameter as true, to enable the server to release the continuation points that it reserved. Note though that when it is true, the server will not return any data, so in normal reads you must keep it false.

nodesToRead - The node data for which the history is requested. Define the continuationPoints here, if you wish to continue a previous request that returned continuationPoints.

Returns:

the AsyncResult object that you can monitor for the results. The results will be provided as HistoryReadResponse.

Throws:

ServerConnectionException - if not connected to the server

IllegalArgumentException - if details cannot be encoded

See Also:

historyRead(com.prosysopc.ua.stack.core.HistoryReadDetails, com.prosysopc.ua.stack.core.TimestampsToReturn, java.lang.Boolean, com.prosysopc.ua.stack.core.HistoryReadValueId...), historyReadAtTimes(com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.DateTime[], com.prosysopc.ua.stack.utils.NumericRange, com.prosysopc.ua.stack.core.TimestampsToReturn), historyReadEvents(com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, com.prosysopc.ua.stack.core.EventFilter, com.prosysopc.ua.stack.core.TimestampsToReturn), historyReadModified(com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, com.prosysopc.ua.stack.utils.NumericRange, com.prosysopc.ua.stack.core.TimestampsToReturn), historyReadProcessed(com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.DateTime, java.lang.Double, com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.core.AggregateConfiguration, com.prosysopc.ua.stack.utils.NumericRange, com.prosysopc.ua.stack.core.TimestampsToReturn), historyReadRaw(com.prosysopc.ua.stack.builtintypes.NodeId, com.prosysopc.ua.stack.builtintypes.DateTime, com.prosysopc.ua.stack.builtintypes.DateTime, long, java.lang.Boolean, com.prosysopc.ua.stack.utils.NumericRange, com.prosysopc.ua.stack.core.TimestampsToReturn)

historyReadAtTimes
```
public DataValue[] historyReadAtTimes(NodeId nodeId,
                                      DateTime[] reqTimes,
                                      NumericRange indexRange,
                                      TimestampsToReturn timestampsToReturn)
                               throws StatusException,
                                      ServerConnectionException,
                                      ServiceException,
                                      DecodingException
```
Reads history at specified times.
The method equals to historyReadAtTimes(NodeId, DateTime[], NumericRange, TimestampsToReturn, Boolean) called with useSimpleBounds=false.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeId - the NodeId of the node whose history should be read

reqTimes - the timestamps from which history should be read

indexRange - the range of array indexes to use for array values. If null, all values should be returned. The first array element is identified with 0. Should be null, if the variable is not an array.
Note that the range applies to each element of the history data samples; not to the elements of the returned array of data.

timestampsToReturn - which timestamps to return with the values

Returns:

the history values for the requested times

Throws:

StatusException - if the operation fails

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

historyReadAtTimes
```
public DataValue[] historyReadAtTimes(NodeId nodeId,
                                      DateTime[] reqTimes,
                                      NumericRange indexRange,
                                      TimestampsToReturn timestampsToReturn,
                                      Boolean useSimpleBounds)
                               throws StatusException,
                                      ServerConnectionException,
                                      ServiceException,
                                      DecodingException
```
Reads history at specified times.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeId - the NodeId of the node whose history should be read

reqTimes - the timestamps from which history should be read

indexRange - the range of array indexes to use for array values. If null, all values should be returned. The first array element is identified with 0. Should be null, if the variable is not an array.
Note that the range applies to each element of the history data samples; not to the elements of the returned array of data.

timestampsToReturn - which timestamps to return with the values

useSimpleBounds - whether the server is instructed to interpolate values using the SimpleBounds algorithm or the normal one as defined in (OPC UA Part 13. Aggregates Specification).

Returns:

the history values for the requested times

Throws:

StatusException - if the operation fails

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

historyReadAtTimes
```
public HistoryReadResult[] historyReadAtTimes(NodeId[] nodeIds,
                                              DateTime[] reqTimes,
                                              NumericRange indexRange,
                                              TimestampsToReturn timestampsToReturn,
                                              Boolean useSimpleBounds)
                                       throws ServerConnectionException,
                                              ServiceException,
                                              DecodingException,
                                              EncodingException
```
Reads history at specified times.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeIds - the NodeIds of the nodes whose history should be read

reqTimes - the timestamps from which history should be read

indexRange - the range of array indexes to use for array values. If null, all values should be returned. The first array element is identified with 0. Should be null, if the variable is not an array.
Note that the range applies to each element of the history data samples; not to the elements of the returned array of data.

timestampsToReturn - which timestamps to return with the values

useSimpleBounds - whether the server is instructed to interpolate values using the SimpleBounds algorithm or the normal one as defined in (OPC UA Part 13. Aggregates Specification).

Returns:

the history read results for the requested times

Throws:

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

EncodingException - if the returned data could not be encoded to ExtensionObject

historyReadEvents
```
public HistoryEventFieldList[] historyReadEvents(NodeId nodeId,
                                                 DateTime startTime,
                                                 DateTime endTime,
                                                 UnsignedInteger numValuesPerNode,
                                                 EventFilter filter,
                                                 TimestampsToReturn timestampsToReturn)
                                          throws StatusException,
                                                 ServerConnectionException,
                                                 ServiceException,
                                                 DecodingException
```
Reads events from history.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeId - the NodeId of the node whose history should be read

startTime - the beginning of the time interval

endTime - the end of the time interval. If endTime is less than startTime the data will be returned in reverse order

numValuesPerNode - the maximum number of events to return per one internal call. If the value is 0, all events between startTime and endTime are returned in one call. If the value is bigger or the server decides to break the call, the server will respond with a continuationPoint, which the client can use to automatically request all values with subsequent reads.

timestampsToReturn - which timestamps to return with the values

filter - the filter to use for selecting the events to include. You can use the ContentFilterBuilder to create the WhereClause of the filter, the same way that you do for the MonitoredEventItem.setEventFilter(EventFilter).

Returns:

the list of events corresponding to the request

Throws:

StatusException - if the operation fails

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

historyReadEvents
```
public HistoryReadResult[] historyReadEvents(NodeId[] nodeIds,
                                             DateTime startTime,
                                             DateTime endTime,
                                             UnsignedInteger numValuesPerNode,
                                             EventFilter filter,
                                             TimestampsToReturn timestampsToReturn)
                                      throws ServerConnectionException,
                                             ServiceException,
                                             DecodingException,
                                             EncodingException
```
Reads events from history.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeIds - the NodeIds of the nodes whose history should be read

startTime - the beginning of the time interval

endTime - the end of the time interval. If endTime is less than startTime the data will be returned in reverse order

numValuesPerNode - the maximum number of events to return per one internal call. If the value is 0, all events between startTime and endTime are returned in one call. If the value is bigger or the server decides to break the call, the server will respond with a continuationPoint, which the client can use to automatically request all values with subsequent reads.

timestampsToReturn - which timestamps to return with the values

filter - the filter to use for selecting the events to include. You can use the ContentFilterBuilder to create the WhereClause of the filter, the same way that you do for the MonitoredEventItem.setEventFilter(EventFilter).

Returns:

the history read results

Throws:

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

EncodingException - if the returned data could not be encoded to ExtensionObject

historyReadModified
```
public HistoryModifiedData historyReadModified(NodeId nodeId,
                                               DateTime startTime,
                                               DateTime endTime,
                                               UnsignedInteger numValuesPerNode,
                                               NumericRange indexRange,
                                               TimestampsToReturn timestampsToReturn)
                                        throws StatusException,
                                               ServerConnectionException,
                                               ServiceException,
                                               DecodingException
```
Reads Modified values from the history.
If a value has been modified multiple times, all values for the time are returned. This means that a timestamp can appear in the array more than once.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeId - the NodeId of the node whose history should be read

startTime - the beginning of the time interval

endTime - the end of the time interval. If endTime is less than startTime the data will be returned in reverse order

numValuesPerNode - the maximum number of values to return per one internal call. If the value is 0, all values between startTime and endTime are returned in one call. If the value is bigger or the server decides to break the call, the server will respond with a continuationPoint, which the client can use to automatically request all values with subsequent reads.

indexRange - the range of array indexes to use for array values. If null, all values should be returned. The first array element is identified with 0. Should be null, if the variable is not an array.

timestampsToReturn - which timestamps to return with the values

Returns:

the read data values

Throws:

StatusException - if the operation fails

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

historyReadModified
```
public HistoryReadResult[] historyReadModified(NodeId[] nodeIds,
                                               DateTime startTime,
                                               DateTime endTime,
                                               UnsignedInteger numValuesPerNode,
                                               NumericRange indexRange,
                                               TimestampsToReturn timestampsToReturn)
                                        throws ServerConnectionException,
                                               ServiceException,
                                               DecodingException,
                                               EncodingException
```
Reads Modified values from the history.
If a value has been modified multiple times, all values for the time are returned. This means that a timestamp can appear in the array more than once.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeIds - the NodeIds of the nodes whose history should be read

startTime - the beginning of the time interval

endTime - the end of the time interval. If endTime is less than startTime the data will be returned in reverse order

numValuesPerNode - the maximum number of values to return per one internal call. If the value is 0, all values between startTime and endTime are returned in one call. If the value is bigger or the server decides to break the call, the server will respond with a continuationPoint, which the client can use to automatically request all values with subsequent reads.

indexRange - the range of array indexes to use for array values. If null, all values should be returned. The first array element is identified with 0. Should be null, if the variable is not an array.

timestampsToReturn - which timestamps to return with the values

Returns:

the history read results

Throws:

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

EncodingException - if the returned data could not be encoded to ExtensionObject

historyReadProcessed
```
public DataValue[] historyReadProcessed(NodeId nodeId,
                                        DateTime startTime,
                                        DateTime endTime,
                                        Double processingInterval,
                                        NodeId aggregateType,
                                        AggregateConfiguration aggregateConfiguration,
                                        NumericRange indexRange,
                                        TimestampsToReturn timestampsToReturn)
                                 throws ServerConnectionException,
                                        ServiceException,
                                        DecodingException,
                                        StatusException
```
Reads processed history data. The server should return Aggregate values from the node history matching the requested timestamps.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeId - the NodeId of the node whose history should be read

startTime - the beginning of the time interval

endTime - the end of the time interval. If endTime is less than startTime the data will be returned in reverse order. EndTime must not be equal to startTime.

processingInterval - Interval between returned Aggregate values (in milliseconds). The value 0 indicates that there is no Interval defined.

aggregateType - The NodeId of the HistoryAggregate object that indicates the Aggregate Function to use, when retrieving processed history. You can use one of the Identifiers.AggregateFunction_X values in the SDK, but in practice the supported functions are defined by the servers. You can look for the supported functions by reading the list of NodeIds under the Identifiers.HistoryServerCapabilities_AggregateFunctions folder. See [UA Part 13] for details.

aggregateConfiguration - Aggregate configuration structure

indexRange - which elements of arrays to return, null returns all. this parameter is always null if the value is not an array

timestampsToReturn - which timestamps to return with the values

Returns:

the read data values

Throws:

StatusException - if the operation fails

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

historyReadProcessed
```
public HistoryReadResult[] historyReadProcessed(NodeId[] nodeIds,
                                                DateTime startTime,
                                                DateTime endTime,
                                                Double processingInterval,
                                                NodeId aggregateType,
                                                AggregateConfiguration aggregateConfiguration,
                                                NumericRange indexRange,
                                                TimestampsToReturn timestampsToReturn)
                                         throws ServerConnectionException,
                                                ServiceException,
                                                DecodingException,
                                                EncodingException
```
Reads processed history data. The server should return Aggregate values from the node history matching the requested timestamps.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeIds - the NodeIds of the nodes whose history should be read

startTime - the beginning of the time interval

endTime - the end of the time interval. If endTime is less than startTime the data will be returned in reverse order. EndTime must not be equal to startTime.

processingInterval - Interval between returned Aggregate values (in milliseconds). The value 0 indicates that there is no Interval defined.

aggregateType - The NodeId of the HistoryAggregate object that indicates the Aggregate Function to use, when retrieving processed history. You can use one of the Identifiers.AggregateFunction_X values in the SDK, but in practice the supported functions are defined by the servers. You can look for the supported functions by reading the list of NodeIds under the Identifiers.HistoryServerCapabilities_AggregateFunctions folder. See [UA Part 13] for details.

aggregateConfiguration - Aggregate configuration structure

indexRange - which elements of arrays to return, null returns all. this parameter is always null if the value is not an array

indexRange - which elements of arrays to return, null returns all. this parameter is always null if the value is not an array

timestampsToReturn - which timestamps to return with the values

Returns:

the history read results

Throws:

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

EncodingException - if the returned data could not be encoded to ExtensionObject

historyReadRaw
```
public DataValue[] historyReadRaw(NodeId nodeId,
                                  DateTime startTime,
                                  DateTime endTime,
                                  long numValuesPerNode,
                                  Boolean returnBounds,
                                  NumericRange indexRange,
                                  TimestampsToReturn timestampsToReturn)
                           throws ServerConnectionException,
                                  DecodingException,
                                  ServiceException,
                                  StatusException
```
Reads raw history data. The server should return Raw values from the node history between the requested time interval.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeId - the NodeId of the node whose history should be read

startTime - the beginning of the time interval

endTime - the end of the time interval. If endTime is less than startTime the data will be returned in reverse order. EndTime must not be equal to startTime.

numValuesPerNode - the maximum number of values to return per one internal call. If the value is 0, all values between startTime and endTime are returned in one call. If the value is bigger or the server decides to break the call, the server will respond with a continuationPoint, which the client can use to automatically request all values with subsequent reads. The value must fit in the range of UnsignedInteger

returnBounds - whether values at the boundaries, corresponding to startTime and endtime, should be included in the result set

indexRange - which elements of arrays to return, null returns all. this parameter is always null if the value is not an array

timestampsToReturn - which timestamps to return with the values

Returns:

the read data values

Throws:

StatusException - if the operation fails

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

historyReadRaw
```
public DataValue[] historyReadRaw(NodeId nodeId,
                                  DateTime startTime,
                                  DateTime endTime,
                                  UnsignedInteger numValuesPerNode,
                                  Boolean returnBounds,
                                  NumericRange indexRange,
                                  TimestampsToReturn timestampsToReturn)
                           throws ServerConnectionException,
                                  ServiceException,
                                  DecodingException,
                                  StatusException
```
Reads raw history data. The server should return Raw values from the node history between the requested time interval.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeId - the NodeId of the node whose history should be read

startTime - the beginning of the time interval

endTime - the end of the time interval. If endTime is less than startTime the data will be returned in reverse order. EndTime must not be equal to startTime.

numValuesPerNode - the maximum number of values to return per one internal call. If the value is 0, all values between startTime and endTime are returned in one call. If the value is bigger or the server decides to break the call, the server will respond with a continuationPoint, which the client can use to automatically request all values with subsequent reads.

returnBounds - whether values at the boundaries, corresponding to startTime and endtime, should be included in the result set

indexRange - which elements of arrays to return, null returns all. this parameter is always null if the value is not an array

timestampsToReturn - which timestamps to return with the values

Returns:

the read data values

Throws:

StatusException - if the operation fails

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

historyReadRaw
```
public HistoryReadResult[] historyReadRaw(NodeId[] nodeIds,
                                          DateTime startTime,
                                          DateTime endTime,
                                          long numValuesPerNode,
                                          Boolean returnBounds,
                                          NumericRange indexRange,
                                          TimestampsToReturn timestampsToReturn)
                                   throws ServerConnectionException,
                                          ServiceException,
                                          DecodingException,
                                          EncodingException
```
Reads raw history data. The server should return Raw values from the node history between the requested time interval.
The method will make subsequent calls to the server, as long as the server returns continuationPoints, to ensure that a full result set is retrieved. If you suspect that you may get too large results sets (to fit in memory, for instance) this way, it may be better to use historyRead(HistoryReadDetails, TimestampsToReturn, Boolean, HistoryReadValueId...) instead.

Parameters:

nodeIds - the NodeIds of the nodes whose history should be read

startTime - the beginning of the time interval

endTime - the end of the time interval. If endTime is less than startTime the data will be returned in reverse order. EndTime must not be equal to startTime.

numValuesPerNode - the maximum number of values to return per one internal call. If the value is 0, all values between startTime and endTime are returned in one call. If the value is bigger or the server decides to break the call, the server will respond with a continuationPoint, which the client can use to automatically request all values with subsequent reads. The value must fit in the range of UnsignedInteger

returnBounds - whether values at the boundaries, corresponding to startTime and endtime, should be included in the result set

indexRange - which elements of arrays to return, null returns all. this parameter is always null if the value is not an array

timestampsToReturn - which timestamps to return with the values

Returns:

the history read results

Throws:

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

DecodingException - if the returned data could not be decoded (received as an ExtensionObject from the server)

EncodingException - if the returned data could not be encoded to ExtensionObject

historyUpdate
```
public HistoryUpdateResult[] historyUpdate(HistoryUpdateDetails... details)
                                    throws ServerConnectionException,
                                           ServiceException
```
Update history data in the server.

Parameters:

details - the history update definitions

Returns:

the history update results. If the results contain errors, you can examine the related diagnostic information from getLastOperationDiagnostics().

Throws:

ServerConnectionException - if not connected to the server

ServiceException - if the service call fails

IllegalArgumentException - if details cannot be encoded

historyUpdateAsync
```
public AsyncResult<HistoryUpdateResponse> historyUpdateAsync(HistoryUpdateDetails... details)
                                                      throws ServerConnectionException
```
Update history data in the server.

Parameters:

details - the history update definitions

Returns:

AsyncResult object that can be monitored for the results. The results are available as HistoryUpdateResponse.

Throws:

ServerConnectionException - if not connected to the server

IllegalArgumentException - if details cannot be encoded

historyUpdateData
```
public HistoryUpdateResult historyUpdateData(NodeId nodeId,
                                             PerformUpdateType performInsertReplace,
                                             DataValue[] updateValues)
                                      throws StatusException,
                                             ServerConnectionException,
                                             ServiceException
```
Updates history data.

Insert data functionality
Setting performInsertReplace = INSERT_1 inserts entries into the history database at the specified timestamps for one or more HistoricalDataNodes. If an entry exists at the specified timestamp, the new entry shall not be inserted; instead the StatusCode shall indicate Bad_EntryExists.
This function is intended to insert new entries at the specified timestamps; e.g., the insertion of lab data to reflect the time of data collection.
Replace data functionality
Setting performInsertReplace = REPLACE_2 replaces entries in the history database at the specified timestamps for one or more HistoricalDataNodes. If no entry exists at the specified timestamp, the new entry shall not be inserted; otherwise the StatusCode shall indicate Bad_NoEntryExists.
This function is intended to replace existing entries at the specified timestamp; e.g., correct lab data that was improperly processed, but inserted into the history database.
Update data functionality
Setting performInsertReplace = UPDATE_3 inserts or replaces entries in the history database for the specified timestamps for one or more HistoricalDataNodes. If the item has an entry at the specified timestamp, the new entry will replace the old one. If there is no entry at that timestamp, the function will insert the new data.
This function is intended to unconditionally insert/replace values and qualities; e.g., correction of values for bad sensors.
Good as a StatusCode for an individual entry is allowed when the server is unable to say whether there was already a value at that timestamp. If the server can determine whether the new entry replaces an entry that was already there, it should use Good_EntryInserted or Good_EntryReplaced to return that information.
(OPC UA Spec. Part 11 v 1.01 6.7.2)

Parameters:

nodeId - the NodeId of the node whose history should be read

performInsertReplace - determines which action of Insert, Replace or Update is performed. Update equals to "Insert or Replace" depending on whether the variable has an entry for the specified timestamp. For Insert and replace a StatusException with StatusCode Bad_EntryExists or Bad_NoEntryExists will be set for operationResults, respectively, if there already is an entry which is being inserted or is no entry that could be replaced.

updateValues - the values to be updated in history

Returns:

results of the operations as HistoryUpdateResult. See the operationResults for the individual result for each of the updateValues.

Throws:

StatusException - if the operation fails

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

historyUpdateEvent
```
public HistoryUpdateResult historyUpdateEvent(NodeId nodeId,
                                              PerformUpdateType performInsertReplace,
                                              EventFilter filter,
                                              HistoryEventFieldList[] eventData)
                                       throws StatusException,
                                              ServerConnectionException,
                                              ServiceException
```
Updates historical events in the server.

This function is intended to insert new entries; e.g., backfilling of historical Events.
Setting performInsertReplace = INSERT_1 inserts entries into the Event history database for one or more HistoricalEventNodes. The whereClause parameter of the EventFilter shall be empty. The SelectClause shall specify the EventType and the Time. The selectClause should specify the SourceNode and the SourceName. If the historian does not support archiving the specified EventType the StatusCode shall indicate Bad_TypeDefinitionInvalid. If the SourceNode is not a valid source for Events the StatusCode shall indicate Bad_SourceNodeIdInvalid. If the Time does not fall within range that can be stored the StatusCode shall indicate Bad_OutOfRange.If the selectClause does not include fields which are mandatory for the EventType the StatusCode shall indicate Bad_ArgumentsMissing. If the selectClause specifies fields which are not valid for the EventType or cannot be saved by the historian the StatusCode shall indicate Good_DataIgnored and the OperationResults array shall specify Bad_NotSupported for each ignored field.
The EventId is a server generated opaque value and a Client cannot assume it knows how to create value EventIds. If a Client does specify the EventId in the selectClause and it matches an existing Event the StatusCode shall indicate Bad_EntryExists. A Client must use a HistoryRead to discover any automatically generated EventIds.
If any errors occur while processing individual fields the StatusCode shall indicate Bad_ArgumentInvalid and the OperationResults array shall specify the exact error for each invalid field. The IndexRange parameter of the SimpleAttributeOperand is not valid for insert operations and the OperationResults shall specify Bad_IndexRangeInvalid if one is specified.
If no errors occur the StatusCode shall indicate Good and the OperationResults array shall be empty. If errors occur OperationResults array will have one element for each field specified in the selectClause.
A Client may instruct the Server to choose a suitable default value for a field by specifying a value of null. If the server is not able to select a suitable default the corresponding entry in the OperationResults array shall be Bad_InvalidArgument.
Replace event functionality
This function is intended to replace fields in existing Event entries; e.g., correct Event data that contained incorrect data due to a bad sensor.
Setting performInsertReplace = REPLACE_2 replaces entries in the Event history database for the specified filter for one or more HistoricalEventNodes. The whereClause parameter of the EventFilter shall specify the EventId Property. If no entry exists matching the specified filter, no updates will be performed, instead the StatusCode shall indicate Bad_NoEntryExists.
If the selectClause specifies fields which are not valid for the EventType or cannot be saved by the historian the StatusCode shall indicate Good_DataIgnored and the OperationResults array shall specify Bad_NotSupported for each ignored field.
If a field is valid for the EventType but cannot be changed the StatusCode shall indicate Good_DataIgnored and the corresponding entry in the OperationResults array shall be Bad_NotWriteable.
If fatal errors occur while processing individual fields the StatusCode shall indicate Bad_ArgumentInvalid and the OperationResults array shall specify the exact error.
If no errors occur the StatusCode shall indicate Good and the OperationResults array shall be empty. If errors occur OperationResults array will have one element for each field specified in the selectClause.
If a Client specifies a value of null for any field the Server shall set the value of the field to null. If a null value is not valid for the corresponding entry in the OperationResults array shall be Bad_InvalidArgument.
Update event functionality
This function is intended to unconditionally insert/replace Events; e.g., synchronizing a backup Event database.
Setting performInsertReplace = UPDATE_3 inserts or replaces entries in the Event history database for the specified filter for one or more HistoricalEventNodes.
The server will, based on its own criteria, attempt to determine if the Event already exists, if it does the existing Event will be deleted and the new Event will be inserted (retaining the EventId). If the event does not exist then a new Event will be inserted, including the generation of a new EventId.
All of the restrictions, behavoirs errors specified for the Insert functionality also apply to this function.
If an existing entry was replaced successfully the StatusCode shall be Good_EntryReplaced. If a new entry was created the StatusCode shall be Good_EntryInserted. If the server cannot determine whether it replaced or inserted an entry it the StatusCode shall be Good.
(OPC UA Spec. Part 11 v 1.01 6.7.4)

Parameters:

nodeId - the NodeId of the node whose history should be read

performInsertReplace - determines which action of Insert, Replace or Update is performed. Update equals to "Insert or Replace" depending on whether the variable has an entry for the specified timestamp.

filter - the filter defines the target of the operation.

eventData - the event data to be updated

Returns:

results of the operations as HistoryUpdateResult.

Throws:

StatusException - if the operation fails

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

historyUpdateStructureData
```
public HistoryUpdateResult historyUpdateStructureData(NodeId nodeId,
                                                      PerformUpdateType performInsertReplace,
                                                      DataValue[] updateValues)
                                               throws StatusException,
                                                      ServerConnectionException,
                                                      ServiceException
```
Updates historical structure data.

Structured History Data provides metadata describing an entry in the history database. The server shall define what uniqueness means for each Structured History Data structure type. For example, a server may only allow one Annotation per timestamp which means the timestamp is the unique key for the structure. Another server may allow for multiple Annotations to exist per user, so a combination username, Timestamp and message may be used as the unique key for the structure. In the following sections the terms "Structured History Data exists" and "at the specificed parameters" means a matching entry has been found at the specified timestamp using the Server's criteria for uniqueness.
In the case where the Client wishes to Replace a parameter that is part of the uniqueness criteria, the resulting StatusCode would be Bad_NoEntryExists. They will have to Remove the existing structure and Insert the new structure.
Insert functionality
Setting performInsertReplace = INSERT_1 inserts Structured History Data such as Annotations, into the history database at the specified parameters for one or more Properties of HistoricalDataNodes
If a Structured History Data entry already exists at the specified parameters the StatusCode shall indicate Bad_EntryExists.
Replace functionality
Setting performInsertReplace = REPLACE_2 replaces Structured History Data such as Annotations in the history database at the specified parameters for one or more Properties of HistoricalDataNodes.
If a Structured History Data entry does not already exist at the specified parameters, the StatusCode shall indicate Bad_NoEntryExists.
Update functionality
Setting performInsertReplace = UPDATE_3 inserts or replaces Structure Data such as Annotations in the history database at the specified parameters for one or more Properties of HistoricalDataNodes.
If a Structure History Data entry already exists at the specified parameters it is deleted and the value provided by the Client is inserted. If no existing entry exists the new entry is inserted.
If an existing entry was replaced successfully the StatusCode shall be Good_EntryReplaced. If a new entry was created the StatusCode shall be Good_EntryInserted. If the server cannot determine whether it replaced or inserted an entry it the StatusCode shall be Good.
Remove functionality
Setting performInsertReplace = REMOVE_4 removes Structure Data such as Annotations from the history database at the specified parameters for one or more Properties of HistoricalDataNodes.
If a Structure History Data entry exists at the specified parameters it is deleted. If Structured History Data does not already exist at the specified parameters, the StatusCode shall indicate Bad_NoEntryExists.
(OPC UA Spec. Part 11 v1.01 6.7.3)

Parameters:

nodeId - the NodeId of the node whose history should be read

performInsertReplace - which action to take in updating (INSERT, REPLACE, UPDATE)

updateValues - the values to be updated in history

Returns:

results of the operation as HistoryUpdateResult

Throws:

StatusException - if the operation fails

ServerConnectionException - if we are not connected to the server

ServiceException - if the service call fails

isAutoReconnect
```
public boolean isAutoReconnect()
```
Automatic reconnection setting. When true, the UaClient will try to reconnect automatically to the server, when communication fails.

Returns:

the doAutoReconnect

isConnected
```
@Deprecated
public boolean isConnected()
```
Deprecated. use hasConnection() or hasConnected() instead.

Deprecated, use hasConnection() or hasConnected() instead.

isInitTypeDictionaryAutoUsage
```
public boolean isInitTypeDictionaryAutoUsage()
```
Returns true if TypeDictionary is read automatically when first encountering custom Structures, unless already initialized at connect as defined by isInitTypeDictionaryOnConnect().

isInitTypeDictionaryOnConnect
```
public boolean isInitTypeDictionaryOnConnect()
```
Returns true if TypeDictionary is read automatically, when connecting to the server.

isInitTypeDictionaryShallow
```
public boolean isInitTypeDictionaryShallow()
```
See setInitTypeDictionaryShallow(boolean).

isInReverseMode
```
public boolean isInReverseMode()
```
Defines whether the client is expecting a Reverse Connection from a server.

See Also:

setReverseAddress(UaAddress), setReversePort(int), setReverseConnectionListener(ReverseConnectionListener), connect()

isKeepSubscriptions
```
public boolean isKeepSubscriptions()
```
Defines whether subscriptions should be kept in the server after disconnect().

isValidateCreateSessionResponseCert
```
public boolean isValidateCreateSessionResponseCert()
```
Define whether the client should validate the server certificate received at session creation.

See Also:

setValidateCreateSessionResponseCert(boolean)

isValidateDiscoveredEndpoints
```
public boolean isValidateDiscoveredEndpoints()
```
Define whether the client should validate the server endpoints received at session creation against those returned for discoverEndpoints().

See Also:

setValidateDiscoveredEndpoints(boolean)

isValidateNonceLength
```
public boolean isValidateNonceLength()
```
Define whether the client should validate the length of the nonce received at session creation.

See Also:

setValidateNonceLength(boolean)

read
```
public ReadResponse read(Double maxAge,
                         TimestampsToReturn timestampsToReturn,
                         ReadValueId... nodesToRead)
                  throws ServiceException
```
This Service is used to read one or more Attributes of one or more Nodes. For constructed Attribute values whose elements are indexed, such as an array, this Service allows Clients to read the entire set of indexed values as a composite, to read individual elements or to read ranges of elements of the composite.
The maxAge parameter is used to direct the Server to access the value from the underlying data source, such as a device, in case its own copy of the data is older than that which the maxAge specifies. If the Server cannot meet the requested max age, it returns its "best effort" value rather than rejecting the request.
Sample usage:
```
 ReadValueId[] nodesToRead = new ReadValueId[2];
 // Scalar value or complete array
 nodesToRead[0] = new ReadValueId(nodeId1, Attributes.Value, null,
 null);
 
 // Part of an array
 NumericRange range = new NumericRange(1, 3);
 nodesToRead[10] = new ReadValueId(nodeId2, Attributes.Value, range.toString(),
 null);
 

 final ReadResponse readResponse = read(UaClient.MAX_CACHE_AGE,
 TimestampsToReturn.Both, nodesToRead);
 final DataValue[] values = readResponse.getResults();
 

 // Use the values:
 if (values[0].getStatusCode().isGood())
 System.out.println(values[0].getValue());
 if (values[1].getStatusCode().isGood())
 System.out.println(values[1].getValue());
 

 
```
Parameters:

timestampsToReturn - An enumeration that specifies the Timestamps to be returned for each requested Variable Value Attribute.

maxAge - Maximum age of the value to be read in milliseconds. The age of the value is based on the difference between the ServerTimestamp and the time when the Server starts processing the request. For example if the Client specifies a maxAge of 500 milliseconds and it takes 100 milliseconds until the Server starts processing the request, the age of the returned value could be 600 milliseconds prior to the time it was requested.
If the Server has one or more values of an Attribute that are within the maximum age, it can return any one of the values or it can read a new value from the data source. The number of values of an Attribute that a Server has depends on the number of MonitoredItems that are defined for the Attribute. In any case, the Client can make no assumption about which copy of the data will be returned.
If the Server does not have a value that is within the maximum age, it shall attempt to read a new value from the data source. If the Server cannot meet the requested maxAge, it returns its "best effort" value rather than rejecting the request. This may occur when the time it takes the Server to process and return the new data value after it has been accessed is greater than the specified maximum age.
If maxAge is set to 0, the Server shall attempt to read a new value from the data source.
If maxAge is set to MAX_CACHE_AGE, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.

nodesToRead - List of Nodes and their Attributes to read. For each entry in this list, a StatusCode is returned, and if it indicates success, the Attribute Value is also returned.
Note that DataEncoding may only be defined for the Value attribute - and the Java stack currently only supports the binary encoding. So typically, it is best to leave it to null.

Returns:

The complete response returned from the server. Use getResults() to read the DataValues. For each value, check StatusCode to learn if there were problems. Also check for DiagnosticInfos, if it contains server specific error information for the items. The following status codes are expected on failures: Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_DataEncodingInvalid, Bad_DataEncodingUnsupported, Bad_NotReadable, Bad_UserAccessDenied

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. The following result codes are expected: Bad_NothingToDo, Bad_TooManyOperations, Bad_MaxAgeInvalid, Bad_TimestampsToReturnInvalid

See Also:

readAsync(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), write(com.prosysopc.ua.stack.core.WriteValue...), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[])

readAsync
```
public AsyncResult<ReadResponse> readAsync(Double maxAge,
                                           TimestampsToReturn timestampsToReturn,
                                           ReadValueId... nodesToRead)
```
Read node attributes from the server asynchronously. This is a generic method, which you can use to read values for several nodes and attributes at once. You can also define specific parameters to optimize the returned data.

Example:
```
 // Read the name of the objects folder, asynchronously.

 NodeId myNodeId = Identifiers.ObjectsFolder;

 // Provide a state listener with the call to watch the state transitions
 // You may read the response when the state has changed to Complete
 // - or wait for it, as is done below.

 ClientServiceRequest r = server.readAsync(new StateListener<ClientServiceRequestState>() {

   @Override
   public void onStateTransition(IStatefulObject<ClientServiceRequestState, ?> sender,
       ClientServiceRequestState oldState, ClientServiceRequestState newState) {
     System.out.println(newState);
   }

 }, Server.MAX_CACHE_AGE, TimestampsToReturn.Both, new ReadValueId(myNodeId, Attributes.NodeId, null, null));
 ReadResponse response = (ReadResponse) r.waitForResult();
 assertTrue(response.getResponseHeader().getServiceResult().isGood());
 DataValue[] v = response.getResults();
 if (v[0].getStatusCode().isGood())
   System.out.println(v[0].getValue().getValue()); // DataValue.Variant.Object
 
```
Parameters:

timestampsToReturn - An enumeration that specifies the Timestamps to be returned for each requested Variable Value Attribute.

maxAge - Maximum age of the value to be read in milliseconds. The age of the value is based on the difference between the ServerTimestamp and the time when the Server starts processing the request. For example if the Client specifies a maxAge of 500 milliseconds and it takes 100 milliseconds until the Server starts processing the request, the age of the returned value could be 600 milliseconds prior to the time it was requested. If the Server has one or more values of an Attribute that are within the maximum age, it can return any one of the values or it can read a new value from the data source. The number of values of an Attribute that a Server has depends on the number of MonitoredItems that are defined for the Attribute. In any case, the Client can make no assumption about which copy of the data will be returned. If the Server does not have a value that is within the maximum age, it shall attempt to read a new value from the data source. If the Server cannot meet the requested maxAge, it returns its "best effort" value rather than rejecting the request. This may occur when the time it takes the Server to process and return the new data value after it has been accessed is greater than the specified maximum age. 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 (@link Integer.MAX_VALUE), the Server shall attempt to get a cached value. Negative values are invalid for maxAge.

nodesToRead - List of Nodes and their Attributes to read. For each entry in this list, a StatusCode is returned, and if it indicates success, the Attribute Value is also returned.
Note that DataEncoding may only be defined for the Value attribute - and the Java stack currently only supports the binary encoding. So typically, it is best to leave it to null.

Returns:

The asynchronous monitor, which will provide the response, when available (as ReadResponse). You can poll it, set a listener or wait for the result (or error).

See Also:

read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), write(com.prosysopc.ua.stack.core.WriteValue...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...)

readAttribute
```
public DataValue readAttribute(ExpandedNodeId nodeId,
                               UnsignedInteger attributeId)
                        throws ServiceException,
                               StatusException
```
Reads the value for the specified single node attribute.
Note: Only use this function occasionally. Use readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]) or readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

attributeId - The attribute to read. See Attributes for valid values.

Returns:

The attribute value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttribute
```
public DataValue readAttribute(ExpandedNodeId nodeId,
                               UnsignedInteger attributeId,
                               NumericRange indexRange,
                               Double maxCacheAge)
                        throws ServiceException,
                               StatusException
```
Reads the value for the specified single node attribute.
Note: Only use this function occasionally. Use readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]) or readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

attributeId - The attribute to read. See Attributes for valid values.

indexRange - An optional range of array indexes from which the value should be read. Applies to the Value attribute only.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The attribute value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttribute
```
public DataValue readAttribute(NodeId nodeId,
                               UnsignedInteger attributeId)
                        throws ServiceException,
                               StatusException
```
Reads the value for the specified single node attribute.
Note: Only use this function occasionally. Use readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]) or readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read.

attributeId - The attribute to read. See Attributes for valid values.

Returns:

The attribute value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttribute
```
public DataValue readAttribute(NodeId nodeId,
                               UnsignedInteger attributeId,
                               NumericRange indexRange,
                               Double maxCacheAge)
                        throws ServiceException,
                               StatusException
```
Reads the value for the specified single node attribute.
Note: Only use this function occasionally. Use readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]) or readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read.

attributeId - The attribute to read. See Attributes for valid values.

indexRange - An optional range of array indexes from which the value should be read. Applies to the Value attribute only.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The attribute value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttribute
```
public DataValue readAttribute(UaNodeId nodeId,
                               UnsignedInteger attributeId)
                        throws ServiceException,
                               StatusException
```
Reads the value for the specified single node attribute.
Note: Only use this function occasionally. Use readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]) or readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

attributeId - The attribute to read. See Attributes for valid values.

Returns:

The attribute value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttribute
```
public DataValue readAttribute(UaNodeId nodeId,
                               UnsignedInteger attributeId,
                               NumericRange indexRange,
                               Double maxCacheAge)
                        throws ServiceException,
                               StatusException
```
Reads the value for the specified single node attribute.
Note: Only use this function occasionally. Use readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]) or readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

attributeId - The attribute to read. See Attributes for valid values.

indexRange - An optional range of array indexes from which the value should be read. Applies to the Value attribute only.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The attribute value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttributes
```
public DataValue[] readAttributes(ExpandedNodeId nodeId,
                                  UnsignedInteger... attributeIds)
                           throws ServiceException,
                                  StatusException
```
Read all attributes of a Node. The read is specified with MAX_CACHE_AGE, enabling the server to return the current value it has in the cache for the attribute.
Note: Only use this function occasionally. Use read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

attributeIds - The attributes to read. See Attributes for valid values.

Returns:

The attribute values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call.

StatusException - If the server returns a bad status for the value.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttributes
```
public DataValue[] readAttributes(ExpandedNodeId nodeId,
                                  UnsignedInteger[] attributeIds,
                                  NumericRange[] indexRanges,
                                  Double maxCacheAge)
                           throws ServiceException,
                                  StatusException
```
Read all attributes of a Node. The read is specified with MAX_CACHE_AGE, enabling the server to return the current value it has in the cache for the attribute.
Note: Only use this function occasionally. Use read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

attributeIds - The attributes to read. See Attributes for valid values.

indexRanges - Optional ranges of array indexes from which the values should be read. Applies to the Value attribute only.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The attribute values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call.

StatusException - If the server returns a bad status for the value.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttributes
```
public DataValue[] readAttributes(NodeId nodeId,
                                  UnsignedInteger... attributeIds)
                           throws ServiceException
```
Read all attributes of a Node.
Note: Only use this function occasionally. Use read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read.

attributeIds - The attributes to read. See Attributes for valid values.

Returns:

The attribute values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttributes
```
public DataValue[] readAttributes(NodeId nodeId,
                                  UnsignedInteger[] attributeIds,
                                  NumericRange[] indexRanges,
                                  Double maxCacheAge)
                           throws ServiceException
```
Read all attributes of a Node.
Note: Only use this function occasionally. Use read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read.

attributeIds - The attributes to read. See Attributes for valid values.

indexRanges - Optional ranges of array indexes from which the values should be read. Applies to the Value attribute only.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The attribute values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttributes
```
public DataValue[] readAttributes(UaNodeId nodeId,
                                  UnsignedInteger... attributeIds)
                           throws ServiceException,
                                  StatusException
```
Read all attributes of a Node. The read is specified with MAX_CACHE_AGE, enabling the server to return the current value it has in the cache for the attribute.
Note: Only use this function occasionally. Use read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

attributeIds - The attributes to read. See Attributes for valid values.

Returns:

The attribute values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call.

StatusException - If the server returns a bad status for the value.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readAttributes
```
public DataValue[] readAttributes(UaNodeId nodeId,
                                  UnsignedInteger[] attributeIds,
                                  NumericRange[] indexRanges,
                                  Double maxCacheAge)
                           throws ServiceException,
                                  StatusException
```
Read all attributes of a Node. The read is specified with MAX_CACHE_AGE, enabling the server to return the current value it has in the cache for the attribute.
Note: Only use this function occasionally. Use read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

attributeIds - The attributes to read. See Attributes for valid values.

indexRanges - Optional ranges of array indexes from which the values should be read. Applies to the Value attribute only.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The attribute values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call.

StatusException - If the server returns a bad status for the value.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...)

readValue
```
public DataValue readValue(ExpandedNodeId nodeId)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(ExpandedNodeId nodeId,
                           Double maxCacheAge)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(ExpandedNodeId nodeId,
                           NumericRange indexRange)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.
For example:
```
 // Read element #1 of the array
 client.readValue(arrayVariableId, new NumericRange(1));
 // Read elements #1-#3 of the one-dimensional array
 client.readValue(arrayVariableId, new NumericRange(1, 3));
 // Read elements #1-#2/#2-#3 of the two-dimensional array
 client.readValue(arrayVariableId, new NumericRange(new int[] {1, 2}, new int[] {2, 3}));
 
```
Parameters:

nodeId - The node to read. Only local nodes are supported.

indexRange - An optional range of array indexes from which the value should be read. Applies to the Value attribute only.

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(ExpandedNodeId nodeId,
                           NumericRange indexRange,
                           Double maxCacheAge)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.
For example:
```
 // Read element #1 of the array - from device (maxCacheAge=0)
 client.readValue(arrayVariableId, new NumericRange(1), 0);
 // Read elements #1-#3 of the one-dimensional array
 client.readValue(arrayVariableId, new NumericRange(1, 3), 0);
 // Read elements #1-#2/#2-#3 of the two-dimensional array
 client.readValue(arrayVariableId, new NumericRange(new int[] {1, 2}, new int[] {2, 3}), 0);
 
```
Parameters:

nodeId - The node to read. Only local nodes are supported.

indexRange - An optional range of array indexes from which the value should be read. Applies to the Value attribute only.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(NodeId nodeId)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read.

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(NodeId nodeId,
                           Double maxCacheAge)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(NodeId nodeId,
                           NumericRange indexRange)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.
For example:
```
 // Read element #1 of the array
 client.readValue(arrayVariableId, new NumericRange(1));
 // Read elements #1-#3 of the one-dimensional array
 client.readValue(arrayVariableId, new NumericRange(1, 3));
 // Read elements #1-#2/#2-#3 of the two-dimensional array
 client.readValue(arrayVariableId, new NumericRange(new int[] {1, 2}, new int[] {2, 3}));
 
```
Parameters:

nodeId - The node to read.

indexRange - An optional range of array indexes from which the value should be read. Applies to the Value attribute only.

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(NodeId nodeId,
                           NumericRange indexRange,
                           Double maxCacheAge)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.
For example:
```
 // Read element #1 of the array - from device (maxCacheAge=0)
 client.readValue(arrayVariableId, new NumericRange(1), 0);
 // Read elements #1-#3 of the one-dimensional array
 client.readValue(arrayVariableId, new NumericRange(1, 3), 0);
 // Read elements #1-#2/#2-#3 of the two-dimensional array
 client.readValue(arrayVariableId, new NumericRange(new int[] {1, 2}, new int[] {2, 3}), 0);
 
```
Parameters:

nodeId - The node to read.

indexRange - An optional range of array indexes from which the value should be read. Applies to the Value attribute only.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(UaNodeId nodeId)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(UaNodeId nodeId,
                           Double maxCacheAge)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.

Parameters:

nodeId - The node to read. Only local nodes are supported.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(UaNodeId nodeId,
                           NumericRange indexRange)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.
For example:
```
 // Read element #1 of the array
 client.readValue(arrayVariableId, new NumericRange(1));
 // Read elements #1-#3 of the one-dimensional array
 client.readValue(arrayVariableId, new NumericRange(1, 3));
 // Read elements #1-#2/#2-#3 of the two-dimensional array
 client.readValue(arrayVariableId, new NumericRange(new int[] {1, 2}, new int[] {2, 3}));
 
```
Parameters:

nodeId - The node to read. Only local nodes are supported.

indexRange - An optional range of array indexes from which the value should be read. Applies to the Value attribute only.

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValue
```
public DataValue readValue(UaNodeId nodeId,
                           NumericRange indexRange,
                           Double maxCacheAge)
                    throws ServiceException,
                           StatusException
```
Reads the value attribute of a node.
Note: Only use this function occasionally. Use readValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[]), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...) or read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...) instead, when you need to read several nodes or attributes.
For example:
```
 // Read element #1 of the array - from device (maxCacheAge=0)
 client.readValue(arrayVariableId, new NumericRange(1), 0);
 // Read elements #1-#3 of the one-dimensional array
 client.readValue(arrayVariableId, new NumericRange(1, 3), 0);
 // Read elements #1-#2/#2-#3 of the two-dimensional array
 client.readValue(arrayVariableId, new NumericRange(new int[] {1, 2}, new int[] {2, 3}), 0);
 
```
Parameters:

nodeId - The node to read. Only local nodes are supported.

indexRange - An optional range of array indexes from which the value should be read. Applies to the Value attribute only.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The value (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(ExpandedNodeId[] nodeIds)
                       throws ServiceException,
                              StatusException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read. Only local nodes are supported.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(ExpandedNodeId[] nodeIds,
                              NumericRange[] indexRanges)
                       throws ServiceException,
                              StatusException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read. Only local nodes are supported.

indexRanges - Optional ranges of array indexes from which the values should be read.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(ExpandedNodeId[] nodeIds,
                              NumericRange[] indexRanges,
                              TimestampsToReturn timestamps)
                       throws ServiceException,
                              StatusException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read. Only local nodes are supported.

indexRanges - Optional ranges of array indexes from which the values should be read.

timestamps - Define which timestamps to return with each value. The default is to request TimestampsToReturn.Both.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(ExpandedNodeId[] nodeIds,
                              NumericRange[] indexRanges,
                              TimestampsToReturn timestamps,
                              Double maxCacheAge)
                       throws ServiceException,
                              StatusException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read. Only local nodes are supported.

indexRanges - Optional ranges of array indexes from which the values should be read.

timestamps - Define which timestamps to return with each value. The default is to request TimestampsToReturn.Both.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(ExpandedNodeId[] nodeIds,
                              TimestampsToReturn timestamps)
                       throws ServiceException,
                              StatusException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read. Only local nodes are supported.

timestamps - Define which timestamps to return with each value.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(NodeId[] nodeIds)
                       throws ServiceException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(NodeId[] nodeIds,
                              NumericRange[] indexRanges)
                       throws ServiceException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read.

indexRanges - Optional ranges of array indexes from which the values should be read.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(NodeId[] nodeIds,
                              NumericRange[] indexRanges,
                              TimestampsToReturn timestamps)
                       throws ServiceException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read.

indexRanges - Optional ranges of array indexes from which the values should be read.

timestamps - Define which timestamps to return with each value. The default is to request TimestampsToReturn.Both.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(NodeId[] nodeIds,
                              NumericRange[] indexRanges,
                              TimestampsToReturn timestamps,
                              Double maxCacheAge)
                       throws ServiceException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read.

indexRanges - Optional ranges of array indexes from which the values should be read.

timestamps - Define which timestamps to return with each value. The default is to request TimestampsToReturn.Both.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(NodeId[] nodeIds,
                              TimestampsToReturn timestamps)
                       throws ServiceException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read.

timestamps - Define which timestamps to return with each value.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(UaNodeId[] nodeIds)
                       throws ServiceException,
                              StatusException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read. Only local nodes are supported.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(UaNodeId[] nodeIds,
                              NumericRange[] indexRanges)
                       throws ServiceException,
                              StatusException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read. Only local nodes are supported.

indexRanges - Optional ranges of array indexes from which the values should be read.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(UaNodeId[] nodeIds,
                              NumericRange[] indexRanges,
                              TimestampsToReturn timestamps)
                       throws ServiceException,
                              StatusException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read. Only local nodes are supported.

indexRanges - Optional ranges of array indexes from which the values should be read.

timestamps - Define which timestamps to return with each value. The default is to request TimestampsToReturn.Both.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(UaNodeId[] nodeIds,
                              NumericRange[] indexRanges,
                              TimestampsToReturn timestamps,
                              Double maxCacheAge)
                       throws ServiceException,
                              StatusException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read. Only local nodes are supported.

indexRanges - Optional ranges of array indexes from which the values should be read.

timestamps - Define which timestamps to return with each value. The default is to request TimestampsToReturn.Both.

maxCacheAge - Maximum accepted age of the value. If the server has an older value in its cache, it should go and read a new value from the source (e.g. device) instead of returning the value from cache. The default equals to Integer.MAX_VALUE (as Double).

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

readValues
```
public DataValue[] readValues(UaNodeId[] nodeIds,
                              TimestampsToReturn timestamps)
                       throws ServiceException,
                              StatusException
```
Reads the value attribute of several nodes at once.

Parameters:

nodeIds - The nodes to read. Only local nodes are supported.

timestamps - Define which timestamps to return with each value.

Returns:

The values (with status and timestamps)

Throws:

ServiceException - If the server returns a bad ServiceResult code for the service call. Read the exception for the error details and diagnostics.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics.

See Also:

readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger), readAttributes(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger...), read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object)

reconnect
```
public boolean reconnect()
                  throws ServiceException,
                         ConnectException,
                         SessionActivationException
```
Reconnect to the server. Reconnect will first create a new secure channel. If it succeeds, it will activate the current session with the new channel. If the session cannot be activated (i.e. the session has expired or the server restarted), it will create a new session.
It will also try to transfer the subscriptions to the new session, but if it does not succeed, the subscriptions are recreated.
Note that by default, UaClient will start an automatic reconnect sequence whenever the ServerState goes to CommunicationFault. If you wish to use manual reconnection, use setAutoReconnect(boolean) to disable the automatic system first.

Returns:

true if the method managed to reconnect using the old session; false if it connected with a new session

Throws:

ServiceException - if the service call to create the secure channel fails

ConnectException - if the session could not be created

SessionActivationException - if the session activation call fails (for example, user authentication failed)

IllegalStateException - if called while isAutoReconnect() is true (in this case SDK is handling reconnects automatically).

registerModel
```
public void registerModel(ClientCodegenModel codegenModel)
```
Register an information model to use in the application. All the types in the model are then available for the application, when it constructs new instances.

Parameters:

codegenModel - the model created by the codegen.

removeServerStatusListener
```
public boolean removeServerStatusListener(ServerStatusListener serverStatusListener)
```
Remove a listener from the ServerStatus events.

Parameters:

serverStatusListener -

Returns:

true if the listener was in the list of event listeners

removeSubscription
```
public StatusCode removeSubscription(Subscription subscription)
                              throws ServiceException
```
Remove the subscription from Subscriptions. If isConnected the subscription is also deleted from the server.

Parameters:

subscription -

Returns:

If connected, the result of the service call. Otherwise StatusCode.GOOD, if the subscription was removed from Subscriptions. If Subscriptions did not contain it, returns status code Good_NoData.

Throws:

ServiceException - if the service call fails.

See Also:

removeSubscriptions(com.prosysopc.ua.client.Subscription[]), addSubscription(com.prosysopc.ua.client.Subscription), getSubscription(int), getSubscriptionCount()

removeSubscriptions
```
public StatusCode[] removeSubscriptions(Subscription[] subscriptions)
                                 throws ServiceException
```
Remove subscriptions from Subscriptions. If isConnected the subscriptions are also removed from the server.

Parameters:

subscriptions - The subscriptions to remove.

Returns:

If isConnected, the operation results (as StatusCodes). Otherwise StatusCode.GOOD for each subscription, if the subscription was removed from Subscriptions. If Subscriptions did not contain a subscription, returns status code Good_NoData for it.

Throws:

ServiceException - if the service call fails.

See Also:

removeSubscription(com.prosysopc.ua.client.Subscription), addSubscription(com.prosysopc.ua.client.Subscription), getSubscription(int), getSubscriptionCount()

removeSubscriptionsAsync
```
public AsyncResult<StatusCode[]> removeSubscriptionsAsync(Subscription... subscriptions)
                                                   throws ServiceException
```
Remove subscriptions from Subscriptions, asynchronously. If isConnected the subscriptions are also removed from the server. The method does not wait for the operation to terminate before it returns.

Parameters:

subscriptions - The subscriptions to remove.

Returns:

An AsyncResult, which will get the final Result of type StatusCode[], when the operation is ready. If isConnected, the operation results (as StatusCodes). Otherwise StatusCode.GOOD for each subscription, if the subscription was removed from Subscriptions. If Subscriptions did not contain a subscription, returns status code Good_NoData for it.

Throws:

ServiceException

See Also:

removeSubscriptions(com.prosysopc.ua.client.Subscription[]), addSubscription(com.prosysopc.ua.client.Subscription), getSubscription(int), getSubscriptionCount()

resetEndpoint
```
public void resetEndpoint()
```
Undefines the Endpoint. Same as calling setEndpoint(EndpointDescription) with null.

serviceRequest
```
public <T extends ServiceResponse> T serviceRequest(ServiceRequest<T> request)
                                             throws ServiceException
```
Send a custom service request to the server, synchronously.

Type Parameters:

T -

Parameters:

request - The service request object, e.g. TestStackRequest

Returns:

The service response. Cast this to the expected type, e.g. TestStackResponse

Throws:

ServiceException - if the service call fails

See Also:

serviceRequestAsync(com.prosysopc.ua.stack.builtintypes.ServiceRequest<T>)

serviceRequestAsync
```
public <T extends ServiceResponse> AsyncResult<T> serviceRequestAsync(ServiceRequest<T> request)
                                                               throws ServiceException
```
Send a custom service request to the server, asynchronously.

Type Parameters:

T -

Parameters:

request - The service request object, e.g. TestStackRequest

Returns:

The asynchronous monitor, which will provide the response, when available. You can poll it, set a listener or wait for the result (or error).

Throws:

ServiceException

sessionlessRequest
```
public <T extends ServiceResponse> T sessionlessRequest(ServiceRequest<T> request)
                                                 throws InvalidServerEndpointException,
                                                        ServerConnectionException,
                                                        ServiceException
```
Make a service request to the server over a secure channel. This method can be used in the rare case that you need to send a request without a session to the server.
If hasConnected() (with a session), serviceRequest(ServiceRequest) will be called.

Type Parameters:

T -

Parameters:

request - the service request to send

Returns:

the response to the request (cast it to the correct type)

Throws:

InvalidServerEndpointException - if Uri is not valid, or not listed in the server's list of endpoints

ServerConnectionException - if connection to the server fails

ServiceException - if the service call fails

setAddress
```
public void setAddress(String address)
```
Define the connection address of the OPC UA server as a string.
The address identifies the OPC UA server that we try to connect to. The computer defined by Host of the address must be reachable. If DNS is not available, you can use the IP address of the computer instead.
You cannot change the address when isConnected.
Equals to calling setAddress(UaAddress.parse(address));

Parameters:

address - The connection address of the server. The address is expected to be in format '://:[/]'. See UaAddress.parse(java.lang.String) for details.

Throws:

IllegalArgumentException - if the address is not valid.

See Also:

setAddress(UaAddress)

setAddress
```
public void setAddress(UaAddress address)
```
Define the connection address to the OPC UA server.
The address identifies the OPC UA server that we try to connect to. The computer defined by Host of the address must be reachable. If DNS is not available, you can use the IP address of the computer instead.
You cannot change the address after calling connect(), that is when isConnected.

Parameters:

address - server address to connect to.

See Also:

connect()

setApplicationIdentity
```
public void setApplicationIdentity(ApplicationIdentity applicationIdentity)
```
Set the security identity of the client application. The information is used to define the security settings passed to the server when you connect() to it.

Parameters:

applicationIdentity -

setAuditEntryId
```
public void setAuditEntryId(String auditEntryId)
```
An identifier that identifies the Client's security audit log entry associated with the operations requested from the server. An empty string value means that this parameter is not used.
The AuditEntryId typically contains who initiated the action and from where it was initiated. The AuditEventId is included in the AuditEvent to allow human readers to correlate an Event with the initiating action.

Parameters:

auditEntryId - the auditEntryId to set

setAutoReconnect
```
public void setAutoReconnect(boolean doAutoReconnect)
```
Define automatic reconnection.
Default: true

Parameters:

doAutoReconnect - When true, the UaClient will try to reconnect automatically to the server, when communication fails.

setConnectTimeout
```
public void setConnectTimeout(int connectionTimeoutMilliseconds)
```
Set initial connection timeout in milliseconds. This is how long the client waits to obtain a socket connection. NOTE! The Actual connect() can take longer than the specified value, if the initial connection was obtained in-time. Default value is 60 seconds, i.e. 60000. Note that regardless of this value, the Operating System may timeout the connection earlier. On reverse connections, this value is used to determine how long the client waits for server-initiated connection.

setConnectTimeout
```
public void setConnectTimeout(int value,
                              TimeUnit timeUnit)
```
Convenience method for #setConnectionTimeout(long) taking specific time units. Values that would resolve to be less than one millisecond are treated as 0.

Parameters:

value - value in given timeUnits.

timeUnit - given timeUnits.

setDefaultMaxAge
```
public void setDefaultMaxAge(double defaultMaxAge)
```
Set the default maxAge parameter to be used in Read calls when none is specified in the method signature. Negative values are not allowed. Default is 0.

Parameters:

defaultMaxAge - duration to use, must be 0 or positive. Values higher than Int32 max value are not recommended, as they should all behave the same according to the specification (i.e. server should use cached value).

Throws:

IllegalArgumentException - if given value is less than 0

setDefaultTimestampsToReturn
```
public void setDefaultTimestampsToReturn(TimestampsToReturn defaultTimestampsToReturn)
```
Set the default TimestampsToReturn parameter to be used in Read calls when none is specified in the method signature. Default value is TimestampsToReturn.Both.

setEndpoint
```
public void setEndpoint(EndpointDescription endpoint)
```
Use the EndpointDescription to select the server endpoint to connect to.
Note: Must be not hasConnected() when changing the endpoint.

Parameters:

endpoint - the endpoint to use.

See Also:

setAddress(java.lang.String)

setInitTypeDictionaryAutoUsage
```
public void setInitTypeDictionaryAutoUsage(boolean initTypeDictionaryAutoUsage)
```
Controls if TypeDictionary is initialized automatically, when custom Structures are encountered for the first time.
Calling this method after connect() does not affect the current connection, only the subsequent connections.
Default is true.

See Also:

isInitTypeDictionaryAutoUsage(), setInitTypeDictionaryOnConnect(boolean)

setInitTypeDictionaryOnConnect
```
public void setInitTypeDictionaryOnConnect(boolean initTypeDictionaryOnConnect)
```
Controls if TypeDictionary is initialized automatically after connect().
If false, the dictionaries are initialized when first encountered, if isInitTypeDictionaryAutoUsage() is true.
Calling this method after connect() does not affect the current connection, only the subsequent connections.
Default is true.

See Also:

isInitTypeDictionaryOnConnect(), setInitTypeDictionaryAutoUsage(boolean)

setInitTypeDictionaryShallow
```
public void setInitTypeDictionaryShallow(boolean initTypeDictionaryShallow)
```
If set to true, TypeDictionary will consider it as initialized if it would be initialized, but doesn't do any of the normal initialization procedures, such as reading the types of the server. This can be used to cause TypeDictionary only work in a reactive mode by trying to fetch metadata for UaDataTypeSpecification per encountered DataType. However note that this does work with legacy DataTypeDictionaries only for DataTypes supporting the OPC UA 1.04 DataTypeDefinition Attribute. If false (the default), the TypeDictionary works normally when it initializes (reads all types). This flag should only put to true if knowing connecting to a server known to support 1.04 DataTypeDefinition and additionally for some reason the normal initialization is not good enough. In this case setting this to true might offer performance improvement regarding connection speed, but may offer reductions to any AddressSpace.getNode(NodeId) calls (it should also be noted that these are needed internally to resolve the metadata for UaDataTypeSpecification).

setKeepSubscriptions
```
public void setKeepSubscriptions(boolean keepSubscriptions)
```
Defines that the Subscriptions should be left in the server, when {link disconnect} is called.

Parameters:

keepSubscriptions -

setListener
```
public void setListener(UaClientListener listener)
```
Define the ClientListener to get notifications of client events.

Parameters:

listener - the listener to set

setLocale
```
public void setLocale(Locale locale)
```
Define the user locale, in which all localizable text is requested from the server.
Locale is initialized to the default locale for the Java Virtual Machine.

Parameters:

locale - the locale to set

setMaxResponseMessageSize
```
public void setMaxResponseMessageSize(int maxResponseMessageSize)
```
Define the maximum size, in bytes, for the body of any response message from the server. The server should return Bad_ResponseTooLarge service fault if a response message exceeds this limit.

Parameters:

maxResponseMessageSize - the maxResponseMessageSize to set, the value must be a positive value. Default is 0, which means that it is not used.

setMaxResponseMessageSize
```
public void setMaxResponseMessageSize(UnsignedInteger maxResponseMessageSize)
```
Define the maximum size, in bytes, for the body of any response message from the server. The server should return Bad_ResponseTooLarge service fault if a response message exceeds this limit.

Parameters:

maxResponseMessageSize - the maxResponseMessageSize to set. Default is 0, which means that it is not used. Null is interpreted as 0.

setOperationDiagnosticMask
```
public void setOperationDiagnosticMask(EnumSet<UaApplication.DiagnosticMask> operationDiagnosticMask)
```
Define the operational level diagnostic info to return for the service calls.
Use EnumSet.allOf(DiagnosticMaskBit.class) to request all diagnostics.

Parameters:

operationDiagnosticMask -

See Also:

setServiceDiagnosticMask(java.util.EnumSet<com.prosysopc.ua.UaApplication.DiagnosticMask>)

setPublishRequestFactor
```
public void setPublishRequestFactor(double publishRequestFactor)
```
The factor is used to calculate the number of pending publish requests we are trying to keep open in the server all the time. The factor is used to multiply the number of subscriptions. So, if you have 2 subscriptions and the factor is 2, we will send 4 publish requests to the server and when we get responses, we send the same amount of new requests. The result is rounded up, so that 1 will be the actual minimum number of requests.
The server may respond with Bad_TooManyPublishRequests, if we use a too big a factor, in which case we of course halt sending until we get a good response again.

Parameters:

publishRequestFactor - the new publish request factor. This should normally be at least 1. The default value is 2. When the latency to the server is high, you might like to increase the number.
If you set it to 0 (or negative), no publishRequests will be sent.

setPublishRequestSetpoint
```
public void setPublishRequestSetpoint(int publishRequestSetpoint)
```
Define the target number of PublishRequests to send to the server. The setpoint is calculated based on getPublishRequestFactor() and getSubscriptionCount() and automatically adjusted, if the server sends Bad_TooManyPublishRequest errors for the PublishRequests.

Parameters:

publishRequestSetpoint - the new setpoint value. Use 0 to reset the counter to the default (calculated) value.

setPublishRequestTimeout
```
public void setPublishRequestTimeout(long publishRequestTimeout)
```
Define the timeout used for PublishRequests.
The timeout is not necessary in a normal use case - the PublishRequests should live in the server until it has notifications to send via PublishResponses. In case you experience packet losses in communication, you may need to define a timeout for these messages, so that the client can re-send new PublishRequests even when the responses never arrive to the client. Make sure that the timeout does not overlap with the Subscription keep-alive times, though.
Default: UnsignedInteger.MAX_VALUE (~infinite)

Parameters:

publishRequestTimeout - the timeout in milliseconds, must be a positive value. 0 means no timeout, but it seems that some servers interpret this like timeout immediately.

setPublishRequestTimeout
```
public void setPublishRequestTimeout(long publishRequestTimeout,
                                     TimeUnit timeUnit)
```
/** Define the timeout used for PublishRequests using a specific TimeUnit.
The timeout is not necessary in a normal use case - the PublishRequests should live in the server until it has notifications to send via PublishResponses. In case you experience packet losses in communication, you may need to define a timeout for these messages, so that the client can re-send new PublishRequests even when the responses never arrive to the client. Make sure that the timeout does not overlap with the Subscription keep-alive times, though.
Default: UnsignedInteger.MAX_VALUE (~infinite)

Parameters:

publishRequestTimeout - the timeout publishRequestTimeout. 0 means no timeout, but it seems that some servers interpret this like timeout immediately.

timeUnit - the time unit of publishRequestTimeout (default is milliseconds)

See Also:

setPublishRequestTimeout(long)

setPublishRequestTimeout
```
public void setPublishRequestTimeout(UnsignedInteger publishRequestTimeout)
```
Define the timeout used for PublishRequests.
The timeout is not necessary in a normal use case - the PublishRequests should live in the server until it has notifications to send via PublishResponses. In case you experience packet losses in communication, you may need to define a timeout for these messages, so that the client can re-send new PublishRequests even when the responses never arrive to the client. Make sure that the timeout does not overlap with the Subscription keep-alive times, though.
Default: UnsignedInteger.MAX_VALUE

Parameters:

publishRequestTimeout - the timeout publishRequestTimeout. 0 means no timeout, but it seems that some servers interpret this like timeout immediately, so it will be converted to UnsignedInteger.MAX_VALUE.

setReverseAddress
```
public void setReverseAddress(UaAddress clientListenAddress)
```
Defines a client-side socket address for an OPC UA Reverse Connection.
When you call connect(), the client will start listening to server-initiated connections at this address, according to the OPC UA Specification Part 6. The transport protocol must be 'opc.tcp' and ServerName should be empty. Naturally, the hostname must correspond to an actual hostname or IP address of the local machine.
If you do not want to specify the hostname and only wish to bind to all local addresses you can use setReversePort(int) instead to set a wildcard address. Alternatively, you can create a wildcard address with UaAddress.wildcardOpcTcp(int)).
You can use setReverseConnectionListener(ReverseConnectionListener) to define a custom handler that can validate that the incoming calls are coming from an expected server. If getSecurityMode() defines a secure connection the server certificate must be trusted in order to enable the connection as well.

Throws:

IllegalArgumentException - if the given UaAddress cannot be used for reverse connections

See Also:

isInReverseMode(), setReversePort(int), setReverseConnectionListener(ReverseConnectionListener)

setReverseConnectionListener
```
public void setReverseConnectionListener(ReverseConnectionListener reverseConnectionListener)
```
Set a reverse connection listener that can be used to validate that the incoming calls are coming from an expected server. If getSecurityMode() defines a secure connection the server certificate must be trusted in order to enable the connection as well.

See Also:

setReverseAddress(UaAddress), setReversePort(int), connect()

setReversePort
```
public void setReversePort(int port)
```
Convenience method for defining the Reverse Connection with a specific port number on every network interface. Equals to calling setReverseAddress(UaAddress) with an address created by UaAddress.wildcardOpcTcp(int).

See Also:

setReverseAddress(UaAddress), setReverseConnectionListener(ReverseConnectionListener)

setSecurityMode
```
public void setSecurityMode(SecurityMode securityMode)
```
Define the security mode to connect to.
SecurityMode is a combination of MessageSecurityMode and SecurityPolicy. You can use the predefined constants in SecurityMode as a parameter instead of defining your own values.
You cannot change the setting when isConnected.

Parameters:

securityMode - the new security mode

Throws:

IllegalStateException - if connected when called

setServiceDiagnosticMask
```
public void setServiceDiagnosticMask(EnumSet<UaApplication.DiagnosticMask> serviceDiagnosticMask)
```
Define the service level diagnostic info to return for the service calls.
Use EnumSet.allOf(DiagnosticMaskBit.class) to request all diagnostics.

Parameters:

serviceDiagnosticMask -

See Also:

setOperationDiagnosticMask(java.util.EnumSet<com.prosysopc.ua.UaApplication.DiagnosticMask>)

setSessionName
```
public void setSessionName(String sessionName)
```
Define a name for the session. The value is null by default, which will make the client to auto-generate a new session identifier at each connection.

Parameters:

sessionName - the sessionName to set

setSessionTimeout
```
public void setSessionTimeout(double sessionTimeout)
```
Set the requested session timeout. The value will be revised by the server when you connect(). The revised value can be checked from the current session, available from getSession().
Changes to the value will not take effect until you reconnect().
Default is one hour (3600000 ms)

Parameters:

sessionTimeout - the sessionTimeout to set.

setSessionTimeout

public void setSessionTimeout(long sessionTimeout,
                              TimeUnit timeUnit)

setSocketFactory
```
public void setSocketFactory(TcpConnection.SocketFactory socketFactory)
```
This can be used to override the TcpConnection.DefaultSocketFactory used by TcpConnection.getSocketFactory() for opc.tcp connections (during connect()) reverse connections). If null (the default), the TcpConnection.getSocketFactory() is used.

setStatusCheckInterval
```
public void setStatusCheckInterval(long statusCheckInterval)
```
Define the status check interval, that is, how often the server status is read, when isConnected.
Default is 1000 ms.

Parameters:

statusCheckInterval - The interval in milliseconds. Use 0 to disable the status check.

See Also:

setStatusCheckTimeout(long)

setStatusCheckInterval

public void setStatusCheckInterval(long statusCheckInterval,
                                   TimeUnit timeUnit)

setStatusCheckTimeout
```
public void setStatusCheckTimeout(long statusCheckTimeout)
```
Define the timeout to use for Server Status reads in updateServerStatus().
If you suspect that the server may be busy, or you get a lot of timeouts which cause the status to go to CommunicationFault, you should increase the timeout from the default.
Default: 10000 ms

Parameters:

statusCheckTimeout - the statusCheckTimeout to set (in milliseconds)

See Also:

setStatusCheckInterval(long)

setStatusCheckTimeout

public void setStatusCheckTimeout(long statusCheckTimeout,
                                  TimeUnit timeUnit)

See Also:: setStatusCheckTimeout(long)

setTimeout
```
public void setTimeout(long timeOut)
```
Define the default communication request timeout. The timeout is used for every service request as a hint to the server, but also to define how long we will wait for the response message. If the response takes longer, a ServiceException(Bad_Timeout) is thrown.
The default value null indicates that the OperationTimeout defined by getEndpointConfiguration() should be used.

Parameters:

timeOut - time the new timeout value to set, in milliseconds

setTimeout
```
public void setTimeout(long timeOut,
                       TimeUnit timeUnits)
```
Define the default communication request timeout. The timeout is used for every service request as a hint to the server, but also to define how long we will wait for the response message. If the response takes longer, a ServiceException(Bad_Timeout) is thrown.
The default value null indicates that the OperationTimeout defined by getEndpointConfiguration() should be used.

Parameters:

timeOut - time the new timeout value to set

setTimeout
```
public void setTimeout(UnsignedInteger timeOut)
```
Define the default communication request timeout. The timeout is used for every service request as a hint to the server, but also to define how long we will wait for the response message. If the response takes longer, a ServiceException(Bad_Timeout) is thrown.
The default value null indicates that the OperationTimeout defined by getEndpointConfiguration() should be used.

Parameters:

timeOut - time the new timeout value to set, in milliseconds

setUri
```
@Deprecated
public void setUri(String uri)
```
Deprecated. use setAddress(String) instead.

The connection address of the OPC UA server. The URI is used to locate the server at connect() call.
The server will be connected using the host name and port. It is then queried for endpoints and a suitable one will be picked, even when no exact match is found. In that case a warning message will be display in the log messages.
You cannot change the setting when isConnected.

Parameters:

uri - The server URI to set.

setUserIdentity
```
public void setUserIdentity(UserIdentity userIdentity)
                     throws SessionActivationException
```
Define a new user identity. If you change the identity when isConnected, the session is reactivated using the new user identity.

Parameters:

userIdentity - the new identity. If null, the default, anonymous authentication is set

Throws:

SessionActivationException - if the session activation fails with the new identity

setValidateCreateSessionResponseCert
```
public void setValidateCreateSessionResponseCert(boolean validateCreateSessionResponseCert)
```
Define whether the certificate received in CreateSessionResponse is validated to be the same as used to create the SecureChannel. Some servers with more than one certificate can erroneously return the wrong Cert which causes the connection to fail. You can set this flag to be false, if you know that the server is safe to be connected without the check. Default is true. The check is required for OPC UA compliance.

setValidateDiscoveredEndpoints
```
public void setValidateDiscoveredEndpoints(boolean validateDiscoveredEndpoints)
```
Define whether endpoints discovered from the server are validated against the endpoints returned for a session create request.
By default, the endpoints are validated, but some servers provide different endpointUrls for the GetEndpoints and CreateSession service responses and may therefore fail at connection. You can set this flag to false, if you know that the server is safe to be connected even without the check. Default is true. The check is required for OPC UA compliance.

setValidateNonceLength
```
public void setValidateNonceLength(boolean validateNonceLength)
```
Define whether the length of Nonces received from the server are validated.
By default the check is on, and it makes sure that the server sends long enough Nonces to provide proper session security. In case some server does not support secure conncetions and requires user authentication with plain-text passwords, for example, this check needs to be disabled, in order to enable the connection. Default is true. The check is required for OPC UA compliance.

updateServerStatus
```
public void updateServerStatus()
```
Read the current server status.

write
```
public WriteResponse write(WriteValue... nodesToWrite)
                    throws ServiceException
```
Write values to the server.
The values are written to the data source, such as a device, and the Service does not return until it writes the values or determines that the value cannot be written. In certain cases, the Server will successfully write to an intermediate system or Server, and will not know if the data source was updated properly. In these cases, the Server should report a success code that indicates that the write was not verified. In the cases where the Server is able to verify that it has successfully written to the data source, it reports an unconditional success.
It is possible that the Server may successfully write some Attributes, but not others. Rollback is the responsibility of the Client.
If a Server allows writing of Attributes with the DataType LocalizedText, the Client can add or overwrite the text for a locale by writing the text with the associated LocaleId. Writing a null String for a locale will delete the String for that locale. Writing a null String for the text and a null String for the LocaleId will delete the entries for all locales.

Parameters:

nodesToWrite - List of Nodes and their Attributes to write.

Returns:

WriteResponse defines the result codes for each node in nodesToWrite. Results define the status codes. DiagnosticInfos define server specific additional codes.

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

See Also:

read(java.lang.Double, com.prosysopc.ua.stack.core.TimestampsToReturn, com.prosysopc.ua.stack.core.ReadValueId...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeAsync

public AsyncResult<WriteResponse> writeAsync(WriteValue... nodesToWrite)

Write node attributes to the server asynchronously. This is a generic method, which you can use to write values for several nodes and attributes at once.

Example:

 // Write the name of the objects folder, asynchronously.

 NodeId myNodeId = Identifiers.ObjectsFolder;

 // Provide a state listener with the call to watch the state transitions
 // You may read the response when the state has changed to Complete
 // - or wait for it, as is done below.

 ClientServiceRequest r = server.writeAsync(new StateListener<ClientServiceRequestState>() {
   @Override
   public void onStateTransition(IStatefulObject<ClientServiceRequestState, ?> sender,
       ClientServiceRequestState oldState, ClientServiceRequestState newState) {
     System.out.println(newState);
   }

 }, new WriteValue(OBJECTSFOLDER_NODEID, Attributes.BrowseName, null,
     new DataValue(new Variant(new QualifiedName("Obj")), StatusCode.GOOD)));
 WriteResponse response = (WriteResponse) r.waitForResult();
 StatusCode[] v = response.getResults();
 System.out.println(v[0]);

Parameters:: nodesToWrite - List of Nodes and their Attributes to write. For each entry in this list, a StatusCode is returned.
Returns:: The asynchronous monitor, which will provide the response, when available (as WriteResponse). You can poll it, set a listener or wait for the result (or error).
See Also:: write(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeAttribute
```
public boolean writeAttribute(ExpandedNodeId nodeId,
                              UnsignedInteger attributeId,
                              Object value)
                       throws ServiceException,
                              StatusException
```
Write a single attribute value.
Note: Use write or writeAsync instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

attributeId - The attribute of the node. See Attributes for valid values.

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger)

writeAttribute
```
public boolean writeAttribute(ExpandedNodeId nodeId,
                              UnsignedInteger attributeId,
                              Object value,
                              boolean autoConvert)
                       throws DataTypeConversionException,
                              ServiceException,
                              StatusException
```
Write a single attribute value.
Note: Use write or writeAsync instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

attributeId - The attribute of the node. See Attributes for valid values.

autoConvert - if true, the value will be automatically converted to the DataType of the specified Attribute, note that for Value Attributes the UaClient will first Read the DataType Attribute of the node. If false, value will be written as-is.

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

DataTypeConversionException - if the dataTypeConversion cannot be done

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger)

writeAttribute
```
public boolean writeAttribute(ExpandedNodeId nodeId,
                              UnsignedInteger attributeId,
                              Object value,
                              NumericRange indexRange)
                       throws ServiceException,
                              StatusException
```
Write a single attribute value.
Note: Use write or writeAsync instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

attributeId - The attribute of the node. See Attributes for valid values.

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

indexRange - An optional range of array indexes to which the value should be written to. Applies to the Value attribute only.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger)

writeAttribute
```
public boolean writeAttribute(NodeId nodeId,
                              UnsignedInteger attributeId,
                              Object value)
                       throws ServiceException,
                              StatusException
```
Write a single attribute value.
Note: Use write or writeAsync instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

attributeId - The attribute of the node. See Attributes for valid values.

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger)

writeAttribute
```
public boolean writeAttribute(NodeId nodeId,
                              UnsignedInteger attributeId,
                              Object value,
                              boolean autoConvert)
                       throws DataTypeConversionException,
                              ServiceException,
                              StatusException
```
Write a single attribute value.
Note: Use write or writeAsync instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

attributeId - The attribute of the node. See Attributes for valid values.

autoConvert - if true, the value will be automatically converted to the DataType of the specified Attribute, note that for Value Attributes the UaClient will first Read the DataType Attribute of the node. If false, value will be written as-is.

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

DataTypeConversionException - if the dataTypeConversion cannot be done

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger)

writeAttribute
```
public boolean writeAttribute(NodeId nodeId,
                              UnsignedInteger attributeId,
                              Object value,
                              NumericRange indexRange)
                       throws ServiceException,
                              StatusException
```
Write a single attribute value.
Note: Use write or writeAsync instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

attributeId - The attribute of the node. See Attributes for valid values.

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

indexRange - An optional range of array indexes to which the value should be written to. Applies to the Value attribute only.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger)

writeAttribute
```
public boolean writeAttribute(UaNodeId nodeId,
                              UnsignedInteger attributeId,
                              Object value)
                       throws ServiceException,
                              StatusException
```
Write a single attribute value.
Note: Use write or writeAsync instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

attributeId - The attribute of the node. See Attributes for valid values.

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger)

writeAttribute
```
public boolean writeAttribute(UaNodeId nodeId,
                              UnsignedInteger attributeId,
                              Object value,
                              boolean autoConvert)
                       throws DataTypeConversionException,
                              ServiceException,
                              StatusException
```
Write a single attribute value.
Note: Use write or writeAsync instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

attributeId - The attribute of the node. See Attributes for valid values.

autoConvert - if true, the value will be automatically converted to the DataType of the specified Attribute, note that for Value Attributes the UaClient will first Read the DataType Attribute of the node. If false, value will be written as-is.

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

DataTypeConversionException - if the dataTypeConversion cannot be done

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger)

writeAttribute
```
public boolean writeAttribute(UaNodeId nodeId,
                              UnsignedInteger attributeId,
                              Object value,
                              NumericRange indexRange)
                       throws ServiceException,
                              StatusException
```
Write a single attribute value.
Note: Use write or writeAsync instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

attributeId - The attribute of the node. See Attributes for valid values.

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

indexRange - An optional range of array indexes to which the value should be written to. Applies to the Value attribute only.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeAsync(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger)

writeValue
```
public boolean writeValue(ExpandedNodeId nodeId,
                          Object value)
                   throws ServiceException,
                          StatusException
```
Write the value attribute of a node.
Note: Use writeValues (or write or writeAsync) instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

true if the value was written immediately; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValue
```
public boolean writeValue(ExpandedNodeId nodeId,
                          Object value,
                          boolean autoConvert)
                   throws DataTypeConversionException,
                          ServiceException,
                          StatusException
```
Write the value attribute of a node.
Note: Use writeValues (or write or writeAsync) instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

autoConvert - if true, the value will be automatically converted to the DataType of the variable, note that the UaClient will first Read the DataType Attribute of the node. If false, value will be written as-is.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

DataTypeConversionException - if the dataTypeConversion fails

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValue
```
public boolean writeValue(ExpandedNodeId nodeId,
                          Object value,
                          NumericRange indexRange)
                   throws ServiceException,
                          StatusException
```
Write the value attribute of a node.
Note: Use writeValues (or write or writeAsync) instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

indexRange - An optional range of array indexes to which the value should be written to

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValue
```
public boolean writeValue(NodeId nodeId,
                          Object value)
                   throws ServiceException,
                          StatusException
```
Write the value attribute of a node.
Note: Use writeValues (or write or writeAsync) instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

true if the value was written immediately; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValue
```
public boolean writeValue(NodeId nodeId,
                          Object value,
                          boolean autoConvert)
                   throws DataTypeConversionException,
                          ServiceException,
                          StatusException
```
Write the value attribute of a node.
Note: Use writeValues (or write or writeAsync) instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

autoConvert - if true, the value will be automatically converted to the DataType of the variable, note that the UaClient will first Read the DataType Attribute of the node. If false, value will be written as-is.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

DataTypeConversionException - if the dataTypeConversion fails

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValue
```
public boolean writeValue(NodeId nodeId,
                          Object value,
                          NumericRange indexRange)
                   throws ServiceException,
                          StatusException
```
Write the value attribute of a node.
Note: Use writeValues (or write or writeAsync) instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

indexRange - An optional range of array indexes to which the value should be written to

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValue
```
public boolean writeValue(UaNodeId nodeId,
                          Object value)
                   throws ServiceException,
                          StatusException
```
Write the value attribute of a node.
Note: Use writeValues (or write or writeAsync) instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

true if the value was written immediately; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValue
```
public boolean writeValue(UaNodeId nodeId,
                          Object value,
                          boolean autoConvert)
                   throws DataTypeConversionException,
                          ServiceException,
                          StatusException
```
Write the value attribute of a node.
Note: Use writeValues (or write or writeAsync) instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

autoConvert - if true, the value will be automatically converted to the DataType of the variable, note that the UaClient will first Read the DataType Attribute of the node. If false, value will be written as-is.

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

DataTypeConversionException - if the dataTypeConversion fails

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValue
```
public boolean writeValue(UaNodeId nodeId,
                          Object value,
                          NumericRange indexRange)
                   throws ServiceException,
                          StatusException
```
Write the value attribute of a node.
Note: Use writeValues (or write or writeAsync) instead, when you need to write several values, since it will write them with a single call to the server.

Parameters:

nodeId - The node

value - The new value to write. The value may be a DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

indexRange - An optional range of array indexes to which the value should be written to

Returns:

true if the value was written already; false, if the server returns Good_CompletesAsynchronously. In case the write fails, the method will throw an exception

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

StatusException - If the server returns a bad status for the value. Read the exception for the error details and diagnostics. Expected bad status codes are Bad_NodeIdInvalid, Bad_NodeIdUnknown, Bad_AttributeIdInvalid, Bad_IndexRangeInvalid, Bad_IndexRangeNoData, Bad_WriteNotSupported, Bad_NotWritable, Bad_UserAccessDenied, Bad_OutOfRange, Bad_TypeMismatch

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValues(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId[], java.lang.Object[]), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValues
```
public StatusCode[] writeValues(ExpandedNodeId[] nodeIds,
                                Object[] value)
                         throws ServiceException
```
Write the value attribute of several nodes at once.

Parameters:

nodeIds - The node

value - The new values to write. The values may be DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

The status codes for each written value.

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValues
```
public StatusCode[] writeValues(ExpandedNodeId[] nodeIds,
                                Object[] values,
                                NumericRange[] indexRanges)
                         throws ServiceException
```
Write the value attribute of several nodes at once.

Parameters:

nodeIds - The node

values - The new values to write. The values may be DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

indexRanges - Optional ranges of array indexes to which the values should be written to.

Returns:

The status codes for each written value.

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValues
```
public StatusCode[] writeValues(NodeId[] nodeIds,
                                Object[] value)
                         throws ServiceException
```
Write the value attribute of several nodes at once.

Parameters:

nodeIds - The node

value - The new values to write. The values may be DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

The status codes for each written value.

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValues
```
public StatusCode[] writeValues(NodeId[] nodeIds,
                                Object[] values,
                                NumericRange[] indexRanges)
                         throws ServiceException
```
Write the value attribute of several nodes at once.

Parameters:

nodeIds - The node

values - The new values to write. The values may be DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

indexRanges - Optional ranges of array indexes to which the values should be written to.

Returns:

The status codes for each written value.

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValues
```
public StatusCode[] writeValues(UaNodeId[] nodeIds,
                                Object[] value)
                         throws ServiceException
```
Write the value attribute of several nodes at once.

Parameters:

nodeIds - The node

value - The new values to write. The values may be DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

Returns:

The status codes for each written value.

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

writeValues
```
public StatusCode[] writeValues(UaNodeId[] nodeIds,
                                Object[] values,
                                NumericRange[] indexRanges)
                         throws ServiceException
```
Write the value attribute of several nodes at once.

Parameters:

nodeIds - The node

values - The new values to write. The values may be DataValue, Variant or of native data type. Use DataValue, if you wish to set the status and timestamp as well.

indexRanges - Optional ranges of array indexes to which the values should be written to.

Returns:

The status codes for each written value.

Throws:

ServiceException - If the call fails. Expected ServiceResult codes are Bad_NothingToDo and Bad_TooManyOperations.

See Also:

write(com.prosysopc.ua.stack.core.WriteValue...), writeValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, java.lang.Object), readValue(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId), writeAttribute(com.prosysopc.ua.stack.builtintypes.ExpandedNodeId, com.prosysopc.ua.stack.builtintypes.UnsignedInteger, java.lang.Object)

addSubscriptionAck

protected void addSubscriptionAck(SubscriptionAcknowledgement ack)

getHttpsSecurityPolicies
```
protected HttpsSecurityPolicy[] getHttpsSecurityPolicies()
```
The TLS security policies used for HTTPS communications. In HTTPS, the UA SecurityMode getSecurityMode() is typically NONE, but the transport security must be a secure one.
Default is HttpsSecurityPolicy#ALL.

Returns:

the httpsSecurityPolicies

See Also:

setHttpsSecurityPolicies(com.prosysopc.ua.stack.transport.security.HttpsSecurityPolicy[])

resetPublishRequestSetpoint

protected void resetPublishRequestSetpoint()

Resets the setpoint

resetSubscriptionsAfterRemove

protected void resetSubscriptionsAfterRemove(Subscription[] subscriptions,
                                             StatusCode[] result)

Parameters:: subscriptions -; result -

resolveConnectionAddress
```
protected UaAddress resolveConnectionAddress(UaAddress connectionAddress,
                                             EndpointDescription discoveredEndpoint)
```
This method is used to resolve the connection address that is used to form the socket connection to the "actual endpoint" after Discovery has been done (to getAddress()). By default uses the UaAddress.getProtocol(), UaAddress.getHost() and UaAddress.getPort() components from the connection address. The ServerName component comes from the EndpointDescription.getEndpointUrl().

setHttpsSecurityPolicies
```
protected void setHttpsSecurityPolicies(HttpsSecurityPolicy[] httpsSecurityPolicies)
```
The TLS security policies used for HTTPS communications. In HTTPS, the UA SecurityMode getSecurityMode() is typically NONE, but the transport security must be a secure one.
You can enable all or just some of the policies. The applications will then negotiate a common security mode with each other.
Default is HttpsSecurityPolicy#ALL.

Parameters:

httpsSecurityPolicies - the policies to set

validateServiceRequest
```
protected <T extends ServiceResponse> void validateServiceRequest(ServiceRequest<T> request)
                                                           throws ServiceResultException
```
This method is called before any ServiceRequest is sent to the server (during a Session). By default this method does nothing, but can be used if there is need to change the request or prevent it's sending (by throwing) or to log the request.
IMPORTANT! The request is as-is as it would be sent. This includes the required authentication token within the RequestHeader. After any modification, the same token must exist within the RequestHeader of the request. Additionally, this method is called for every request (except CreateSession and calls related to the secure channel itself), including SDK internal calls to e.g. read the ServerStatus, thus care should be taken to preferably not edit those.

Throws:

ServiceResultException - if the request should not be transmitted to the underlying channel

Class UaClient

Nested Class Summary

Nested classes/interfaces inherited from class com.prosysopc.ua.UaApplication

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.prosysopc.ua.UaApplication

Methods inherited from class java.lang.Object

Field Detail

MAX_CACHE_AGE

Constructor Detail

UaClient

UaClient

UaClient

Method Detail

getCommErrorCodes

getDefaultProtocol

isUseCommErrorCodes

setDefaultProtocol

setUseCommErrorCodes

addServerStatusListener

addSubscription

call

call

callAsync

connect

disconnect

disconnect

disconnect

disconnect

discoverEndpoints

discoverEndpoints

getActualOperationLimits

getActualPublishRequestSetpoint

getAddress

getAddressSpace

getApplicationIdentity

getAuditEntryId

getConnectTimeout

getDefaultMaxAge

getDefaultTimestampsToReturn

getEncoderContext

getEndpoint

getEndpointConfiguration

getHost

getHttpsSettings

getLastOperationDiagnostics

getLastResponseTimestamp

getLastServiceDiagnostics

getLastServiceResult

getListener

getLocale

getMaxResponseMessageSize

getNamespaceTable

getNamespaceTable

getOperationDiagnosticMask

getPort

getProtocol

getPublishRequestFactor

getPublishRequestSetpoint

getPublishRequestTimeout

getReverseAddress

getReverseConnectionListener

getSecureChannel

getSecurityMode

getServerIdentity

getServerName

getServerState

getServerStatus

getServerStatusError

getServerTable

getServerTable

getServerTimeDifference

getServiceDiagnosticMask

getSession

getSessionName

getSessionTimeout

getSocketFactory

getStatusCheckInterval

getStatusCheckTimeout