org.eclipse.milo.opcua.sdk.client.model.types.variables

Interface SessionSecurityDiagnosticsType

All Superinterfaces:

BaseDataVariableType, BaseVariableType, Node, VariableNode

All Known Implementing Classes:

SessionSecurityDiagnosticsTypeNode

public interface SessionSecurityDiagnosticsType
extends BaseDataVariableType

Method Summary

Modifier and Type	Method and Description
String	getAuthenticationMechanism() Get the local value of the AuthenticationMechanism Node.
BaseDataVariableType	getAuthenticationMechanismNode() Get the AuthenticationMechanism BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getAuthenticationMechanismNodeAsync() Asynchronous implementation of getAuthenticationMechanismNode().
org.eclipse.milo.opcua.stack.core.types.builtin.ByteString	getClientCertificate() Get the local value of the ClientCertificate Node.
BaseDataVariableType	getClientCertificateNode() Get the ClientCertificate BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getClientCertificateNodeAsync() Asynchronous implementation of getClientCertificateNode().
String[]	getClientUserIdHistory() Get the local value of the ClientUserIdHistory Node.
BaseDataVariableType	getClientUserIdHistoryNode() Get the ClientUserIdHistory BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getClientUserIdHistoryNodeAsync() Asynchronous implementation of getClientUserIdHistoryNode().
String	getClientUserIdOfSession() Get the local value of the ClientUserIdOfSession Node.
BaseDataVariableType	getClientUserIdOfSessionNode() Get the ClientUserIdOfSession BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getClientUserIdOfSessionNodeAsync() Asynchronous implementation of getClientUserIdOfSessionNode().
String	getEncoding() Get the local value of the Encoding Node.
BaseDataVariableType	getEncodingNode() Get the Encoding BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getEncodingNodeAsync() Asynchronous implementation of getEncodingNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode	getSecurityMode() Get the local value of the SecurityMode Node.
BaseDataVariableType	getSecurityModeNode() Get the SecurityMode BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getSecurityModeNodeAsync() Asynchronous implementation of getSecurityModeNode().
String	getSecurityPolicyUri() Get the local value of the SecurityPolicyUri Node.
BaseDataVariableType	getSecurityPolicyUriNode() Get the SecurityPolicyUri BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getSecurityPolicyUriNodeAsync() Asynchronous implementation of getSecurityPolicyUriNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getSessionId() Get the local value of the SessionId Node.
BaseDataVariableType	getSessionIdNode() Get the SessionId BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getSessionIdNodeAsync() Asynchronous implementation of getSessionIdNode().
String	getTransportProtocol() Get the local value of the TransportProtocol Node.
BaseDataVariableType	getTransportProtocolNode() Get the TransportProtocol BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getTransportProtocolNodeAsync() Asynchronous implementation of getTransportProtocolNode().
String	readAuthenticationMechanism() Read the value of the AuthenticationMechanism Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readAuthenticationMechanismAsync() An asynchronous implementation of readAuthenticationMechanism().
org.eclipse.milo.opcua.stack.core.types.builtin.ByteString	readClientCertificate() Read the value of the ClientCertificate Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>	readClientCertificateAsync() An asynchronous implementation of readClientCertificate().
String[]	readClientUserIdHistory() Read the value of the ClientUserIdHistory Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String[]>	readClientUserIdHistoryAsync() An asynchronous implementation of readClientUserIdHistory().
String	readClientUserIdOfSession() Read the value of the ClientUserIdOfSession Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readClientUserIdOfSessionAsync() An asynchronous implementation of readClientUserIdOfSession().
String	readEncoding() Read the value of the Encoding Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readEncodingAsync() An asynchronous implementation of readEncoding().
org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode	readSecurityMode() Read the value of the SecurityMode Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode>	readSecurityModeAsync() An asynchronous implementation of readSecurityMode().
String	readSecurityPolicyUri() Read the value of the SecurityPolicyUri Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readSecurityPolicyUriAsync() An asynchronous implementation of readSecurityPolicyUri().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readSessionId() Read the value of the SessionId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readSessionIdAsync() An asynchronous implementation of readSessionId().
String	readTransportProtocol() Read the value of the TransportProtocol Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readTransportProtocolAsync() An asynchronous implementation of readTransportProtocol().
void	setAuthenticationMechanism(String authenticationMechanism) Set the local value of the AuthenticationMechanism Node.
void	setClientCertificate(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate) Set the local value of the ClientCertificate Node.
void	setClientUserIdHistory(String[] clientUserIdHistory) Set the local value of the ClientUserIdHistory Node.
void	setClientUserIdOfSession(String clientUserIdOfSession) Set the local value of the ClientUserIdOfSession Node.
void	setEncoding(String encoding) Set the local value of the Encoding Node.
void	setSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode securityMode) Set the local value of the SecurityMode Node.
void	setSecurityPolicyUri(String securityPolicyUri) Set the local value of the SecurityPolicyUri Node.
void	setSessionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sessionId) Set the local value of the SessionId Node.
void	setTransportProtocol(String transportProtocol) Set the local value of the TransportProtocol Node.
void	writeAuthenticationMechanism(String authenticationMechanism) Write a new value for the AuthenticationMechanism Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeAuthenticationMechanismAsync(String authenticationMechanism) An asynchronous implementation of writeAuthenticationMechanism(String).
void	writeClientCertificate(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate) Write a new value for the ClientCertificate Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeClientCertificateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate) An asynchronous implementation of writeClientCertificate(ByteString).
void	writeClientUserIdHistory(String[] clientUserIdHistory) Write a new value for the ClientUserIdHistory Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeClientUserIdHistoryAsync(String[] clientUserIdHistory) An asynchronous implementation of writeClientUserIdHistory(String[]).
void	writeClientUserIdOfSession(String clientUserIdOfSession) Write a new value for the ClientUserIdOfSession Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeClientUserIdOfSessionAsync(String clientUserIdOfSession) An asynchronous implementation of writeClientUserIdOfSession(String).
void	writeEncoding(String encoding) Write a new value for the Encoding Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEncodingAsync(String encoding) An asynchronous implementation of writeEncoding(String).
void	writeSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode securityMode) Write a new value for the SecurityMode Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSecurityModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode securityMode) An asynchronous implementation of writeSecurityMode(MessageSecurityMode).
void	writeSecurityPolicyUri(String securityPolicyUri) Write a new value for the SecurityPolicyUri Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSecurityPolicyUriAsync(String securityPolicyUri) An asynchronous implementation of writeSecurityPolicyUri(String).
void	writeSessionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sessionId) Write a new value for the SessionId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSessionIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sessionId) An asynchronous implementation of writeSessionId(NodeId).
void	writeTransportProtocol(String transportProtocol) Write a new value for the TransportProtocol Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeTransportProtocolAsync(String transportProtocol) An asynchronous implementation of writeTransportProtocol(String).

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

getAccessLevel, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Method Detail

getSessionId

org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getSessionId()
                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SessionId Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the SessionId Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SessionId Node.

setSessionId

void setSessionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sessionId)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SessionId Node.

The value is only updated locally; it is not written to the server.

Parameters:

sessionId - the local value to set for the SessionId Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SessionId Node.

readSessionId

org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readSessionId()
                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the SessionId Node from the server and update the local value if the operation succeeds.

Returns:

the NodeId value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeSessionId

void writeSessionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sessionId)
             throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the SessionId Node to the server and update the local value if the operation succeeds.

Parameters:

sessionId - the NodeId value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readSessionIdAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> readSessionIdAsync()

An asynchronous implementation of readSessionId().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeSessionIdAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSessionIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId sessionId)

An asynchronous implementation of writeSessionId(NodeId).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getSessionIdNode

BaseDataVariableType getSessionIdNode()
                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the SessionId BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the SessionId BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getSessionIdNodeAsync

CompletableFuture<? extends BaseDataVariableType> getSessionIdNodeAsync()

Asynchronous implementation of getSessionIdNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getClientUserIdOfSession

String getClientUserIdOfSession()
                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ClientUserIdOfSession Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the ClientUserIdOfSession Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ClientUserIdOfSession Node.

setClientUserIdOfSession

void setClientUserIdOfSession(String clientUserIdOfSession)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ClientUserIdOfSession Node.

The value is only updated locally; it is not written to the server.

Parameters:

clientUserIdOfSession - the local value to set for the ClientUserIdOfSession Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ClientUserIdOfSession Node.

readClientUserIdOfSession

String readClientUserIdOfSession()
                          throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the ClientUserIdOfSession Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeClientUserIdOfSession

void writeClientUserIdOfSession(String clientUserIdOfSession)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the ClientUserIdOfSession Node to the server and update the local value if the operation succeeds.

Parameters:

clientUserIdOfSession - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readClientUserIdOfSessionAsync

CompletableFuture<? extends String> readClientUserIdOfSessionAsync()

An asynchronous implementation of readClientUserIdOfSession().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeClientUserIdOfSessionAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeClientUserIdOfSessionAsync(String clientUserIdOfSession)

An asynchronous implementation of writeClientUserIdOfSession(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getClientUserIdOfSessionNode

BaseDataVariableType getClientUserIdOfSessionNode()
                                           throws org.eclipse.milo.opcua.stack.core.UaException

Get the ClientUserIdOfSession BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the ClientUserIdOfSession BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getClientUserIdOfSessionNodeAsync

CompletableFuture<? extends BaseDataVariableType> getClientUserIdOfSessionNodeAsync()

Asynchronous implementation of getClientUserIdOfSessionNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getClientUserIdHistory

String[] getClientUserIdHistory()
                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ClientUserIdHistory Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the ClientUserIdHistory Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ClientUserIdHistory Node.

setClientUserIdHistory

void setClientUserIdHistory(String[] clientUserIdHistory)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ClientUserIdHistory Node.

The value is only updated locally; it is not written to the server.

Parameters:

clientUserIdHistory - the local value to set for the ClientUserIdHistory Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ClientUserIdHistory Node.

readClientUserIdHistory

String[] readClientUserIdHistory()
                          throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the ClientUserIdHistory Node from the server and update the local value if the operation succeeds.

Returns:

the String[] value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeClientUserIdHistory

void writeClientUserIdHistory(String[] clientUserIdHistory)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the ClientUserIdHistory Node to the server and update the local value if the operation succeeds.

Parameters:

clientUserIdHistory - the String[] value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readClientUserIdHistoryAsync

CompletableFuture<? extends String[]> readClientUserIdHistoryAsync()

An asynchronous implementation of readClientUserIdHistory().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeClientUserIdHistoryAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeClientUserIdHistoryAsync(String[] clientUserIdHistory)

An asynchronous implementation of writeClientUserIdHistory(String[]).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getClientUserIdHistoryNode

BaseDataVariableType getClientUserIdHistoryNode()
                                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the ClientUserIdHistory BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the ClientUserIdHistory BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getClientUserIdHistoryNodeAsync

CompletableFuture<? extends BaseDataVariableType> getClientUserIdHistoryNodeAsync()

Asynchronous implementation of getClientUserIdHistoryNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getAuthenticationMechanism

String getAuthenticationMechanism()
                           throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the AuthenticationMechanism Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the AuthenticationMechanism Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the AuthenticationMechanism Node.

setAuthenticationMechanism

void setAuthenticationMechanism(String authenticationMechanism)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the AuthenticationMechanism Node.

The value is only updated locally; it is not written to the server.

Parameters:

authenticationMechanism - the local value to set for the AuthenticationMechanism Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the AuthenticationMechanism Node.

readAuthenticationMechanism

String readAuthenticationMechanism()
                            throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the AuthenticationMechanism Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeAuthenticationMechanism

void writeAuthenticationMechanism(String authenticationMechanism)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the AuthenticationMechanism Node to the server and update the local value if the operation succeeds.

Parameters:

authenticationMechanism - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readAuthenticationMechanismAsync

CompletableFuture<? extends String> readAuthenticationMechanismAsync()

An asynchronous implementation of readAuthenticationMechanism().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeAuthenticationMechanismAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeAuthenticationMechanismAsync(String authenticationMechanism)

An asynchronous implementation of writeAuthenticationMechanism(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getAuthenticationMechanismNode

BaseDataVariableType getAuthenticationMechanismNode()
                                             throws org.eclipse.milo.opcua.stack.core.UaException

Get the AuthenticationMechanism BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the AuthenticationMechanism BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getAuthenticationMechanismNodeAsync

CompletableFuture<? extends BaseDataVariableType> getAuthenticationMechanismNodeAsync()

Asynchronous implementation of getAuthenticationMechanismNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getEncoding

String getEncoding()
            throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the Encoding Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the Encoding Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Encoding Node.

setEncoding

void setEncoding(String encoding)
          throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Encoding Node.

The value is only updated locally; it is not written to the server.

Parameters:

encoding - the local value to set for the Encoding Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Encoding Node.

readEncoding

String readEncoding()
             throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the Encoding Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeEncoding

void writeEncoding(String encoding)
            throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the Encoding Node to the server and update the local value if the operation succeeds.

Parameters:

encoding - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readEncodingAsync

CompletableFuture<? extends String> readEncodingAsync()

An asynchronous implementation of readEncoding().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeEncodingAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEncodingAsync(String encoding)

An asynchronous implementation of writeEncoding(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getEncodingNode

BaseDataVariableType getEncodingNode()
                              throws org.eclipse.milo.opcua.stack.core.UaException

Get the Encoding BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the Encoding BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getEncodingNodeAsync

CompletableFuture<? extends BaseDataVariableType> getEncodingNodeAsync()

Asynchronous implementation of getEncodingNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getTransportProtocol

String getTransportProtocol()
                     throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the TransportProtocol Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the TransportProtocol Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the TransportProtocol Node.

setTransportProtocol

void setTransportProtocol(String transportProtocol)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the TransportProtocol Node.

The value is only updated locally; it is not written to the server.

Parameters:

transportProtocol - the local value to set for the TransportProtocol Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the TransportProtocol Node.

readTransportProtocol

String readTransportProtocol()
                      throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the TransportProtocol Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeTransportProtocol

void writeTransportProtocol(String transportProtocol)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the TransportProtocol Node to the server and update the local value if the operation succeeds.

Parameters:

transportProtocol - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readTransportProtocolAsync

CompletableFuture<? extends String> readTransportProtocolAsync()

An asynchronous implementation of readTransportProtocol().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeTransportProtocolAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTransportProtocolAsync(String transportProtocol)

An asynchronous implementation of writeTransportProtocol(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getTransportProtocolNode

BaseDataVariableType getTransportProtocolNode()
                                       throws org.eclipse.milo.opcua.stack.core.UaException

Get the TransportProtocol BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the TransportProtocol BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getTransportProtocolNodeAsync

CompletableFuture<? extends BaseDataVariableType> getTransportProtocolNodeAsync()

Asynchronous implementation of getTransportProtocolNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getSecurityMode

org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode getSecurityMode()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SecurityMode Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the SecurityMode Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityMode Node.

setSecurityMode

void setSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode securityMode)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SecurityMode Node.

The value is only updated locally; it is not written to the server.

Parameters:

securityMode - the local value to set for the SecurityMode Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityMode Node.

readSecurityMode

org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode readSecurityMode()
                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the SecurityMode Node from the server and update the local value if the operation succeeds.

Returns:

the MessageSecurityMode value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeSecurityMode

void writeSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode securityMode)
                throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the SecurityMode Node to the server and update the local value if the operation succeeds.

Parameters:

securityMode - the MessageSecurityMode value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readSecurityModeAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode> readSecurityModeAsync()

An asynchronous implementation of readSecurityMode().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeSecurityModeAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSecurityModeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode securityMode)

An asynchronous implementation of writeSecurityMode(MessageSecurityMode).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getSecurityModeNode

BaseDataVariableType getSecurityModeNode()
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Get the SecurityMode BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the SecurityMode BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getSecurityModeNodeAsync

CompletableFuture<? extends BaseDataVariableType> getSecurityModeNodeAsync()

Asynchronous implementation of getSecurityModeNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getSecurityPolicyUri

String getSecurityPolicyUri()
                     throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SecurityPolicyUri Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the SecurityPolicyUri Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityPolicyUri Node.

setSecurityPolicyUri

void setSecurityPolicyUri(String securityPolicyUri)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SecurityPolicyUri Node.

The value is only updated locally; it is not written to the server.

Parameters:

securityPolicyUri - the local value to set for the SecurityPolicyUri Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityPolicyUri Node.

readSecurityPolicyUri

String readSecurityPolicyUri()
                      throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the SecurityPolicyUri Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeSecurityPolicyUri

void writeSecurityPolicyUri(String securityPolicyUri)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the SecurityPolicyUri Node to the server and update the local value if the operation succeeds.

Parameters:

securityPolicyUri - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readSecurityPolicyUriAsync

CompletableFuture<? extends String> readSecurityPolicyUriAsync()

An asynchronous implementation of readSecurityPolicyUri().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeSecurityPolicyUriAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSecurityPolicyUriAsync(String securityPolicyUri)

An asynchronous implementation of writeSecurityPolicyUri(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getSecurityPolicyUriNode

BaseDataVariableType getSecurityPolicyUriNode()
                                       throws org.eclipse.milo.opcua.stack.core.UaException

Get the SecurityPolicyUri BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the SecurityPolicyUri BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getSecurityPolicyUriNodeAsync

CompletableFuture<? extends BaseDataVariableType> getSecurityPolicyUriNodeAsync()

Asynchronous implementation of getSecurityPolicyUriNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getClientCertificate

org.eclipse.milo.opcua.stack.core.types.builtin.ByteString getClientCertificate()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ClientCertificate Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the ClientCertificate Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ClientCertificate Node.

setClientCertificate

void setClientCertificate(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ClientCertificate Node.

The value is only updated locally; it is not written to the server.

Parameters:

clientCertificate - the local value to set for the ClientCertificate Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ClientCertificate Node.

readClientCertificate

org.eclipse.milo.opcua.stack.core.types.builtin.ByteString readClientCertificate()
                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the ClientCertificate Node from the server and update the local value if the operation succeeds.

Returns:

the ByteString value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeClientCertificate

void writeClientCertificate(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the ClientCertificate Node to the server and update the local value if the operation succeeds.

Parameters:

clientCertificate - the ByteString value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readClientCertificateAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> readClientCertificateAsync()

An asynchronous implementation of readClientCertificate().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeClientCertificateAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeClientCertificateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate)

An asynchronous implementation of writeClientCertificate(ByteString).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getClientCertificateNode

BaseDataVariableType getClientCertificateNode()
                                       throws org.eclipse.milo.opcua.stack.core.UaException

Get the ClientCertificate BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the ClientCertificate BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getClientCertificateNodeAsync

CompletableFuture<? extends BaseDataVariableType> getClientCertificateNodeAsync()

Asynchronous implementation of getClientCertificateNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.