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

Package org.eclipse.milo.opcua.sdk.client.model.objects

Class RoleTypeNode

java.lang.Object

org.eclipse.milo.opcua.sdk.client.nodes.UaNode

org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode

org.eclipse.milo.opcua.sdk.client.model.objects.BaseObjectTypeNode

org.eclipse.milo.opcua.sdk.client.model.objects.RoleTypeNode

All Implemented Interfaces:

BaseObjectType, RoleType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

public class RoleTypeNode
extends BaseObjectTypeNode
implements RoleType

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

client

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.RoleType

APPLICATIONS, APPLICATIONS_EXCLUDE, CUSTOM_CONFIGURATION, ENDPOINTS, ENDPOINTS_EXCLUDE, IDENTITIES

Constructor Summary

Constructors

Constructor

Description

RoleTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Method Summary

Modifier and Type	Method	Description
String[]	getApplications()	Get the local value of the Applications Node.
Boolean	getApplicationsExclude()	Get the local value of the ApplicationsExclude Node.
PropertyTypeNode	getApplicationsExcludeNode()	Get the ApplicationsExclude PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getApplicationsExcludeNodeAsync()	Asynchronous implementation of RoleType.getApplicationsExcludeNode().
PropertyTypeNode	getApplicationsNode()	Get the Applications PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getApplicationsNodeAsync()	Asynchronous implementation of RoleType.getApplicationsNode().
Boolean	getCustomConfiguration()	Get the local value of the CustomConfiguration Node.
PropertyTypeNode	getCustomConfigurationNode()	Get the CustomConfiguration PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getCustomConfigurationNodeAsync()	Asynchronous implementation of RoleType.getCustomConfigurationNode().
org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[]	getEndpoints()	Get the local value of the Endpoints Node.
Boolean	getEndpointsExclude()	Get the local value of the EndpointsExclude Node.
PropertyTypeNode	getEndpointsExcludeNode()	Get the EndpointsExclude PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getEndpointsExcludeNodeAsync()	Asynchronous implementation of RoleType.getEndpointsExcludeNode().
PropertyTypeNode	getEndpointsNode()	Get the Endpoints PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getEndpointsNodeAsync()	Asynchronous implementation of RoleType.getEndpointsNode().
org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[]	getIdentities()	Get the local value of the Identities Node.
PropertyTypeNode	getIdentitiesNode()	Get the Identities PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getIdentitiesNodeAsync()	Asynchronous implementation of RoleType.getIdentitiesNode().
String[]	readApplications()	Read the value of the Applications Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String[]>	readApplicationsAsync()	An asynchronous implementation of RoleType.readApplications().
Boolean	readApplicationsExclude()	Read the value of the ApplicationsExclude Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readApplicationsExcludeAsync()	An asynchronous implementation of RoleType.readApplicationsExclude().
Boolean	readCustomConfiguration()	Read the value of the CustomConfiguration Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readCustomConfigurationAsync()	An asynchronous implementation of RoleType.readCustomConfiguration().
org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[]	readEndpoints()	Read the value of the Endpoints Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[]>	readEndpointsAsync()	An asynchronous implementation of RoleType.readEndpoints().
Boolean	readEndpointsExclude()	Read the value of the EndpointsExclude Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readEndpointsExcludeAsync()	An asynchronous implementation of RoleType.readEndpointsExclude().
org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[]	readIdentities()	Read the value of the Identities Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[]>	readIdentitiesAsync()	An asynchronous implementation of RoleType.readIdentities().
void	setApplications(String[] value)	Set the local value of the Applications Node.
void	setApplicationsExclude(Boolean value)	Set the local value of the ApplicationsExclude Node.
void	setCustomConfiguration(Boolean value)	Set the local value of the CustomConfiguration Node.
void	setEndpoints(org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[] value)	Set the local value of the Endpoints Node.
void	setEndpointsExclude(Boolean value)	Set the local value of the EndpointsExclude Node.
void	setIdentities(org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[] value)	Set the local value of the Identities Node.
void	writeApplications(String[] value)	Write a new value for the Applications Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeApplicationsAsync(String[] applications)	An asynchronous implementation of RoleType.writeApplications(java.lang.String[]).
void	writeApplicationsExclude(Boolean value)	Write a new value for the ApplicationsExclude Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeApplicationsExcludeAsync(Boolean applicationsExclude)	An asynchronous implementation of RoleType.writeApplicationsExclude(java.lang.Boolean).
void	writeCustomConfiguration(Boolean value)	Write a new value for the CustomConfiguration Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCustomConfigurationAsync(Boolean customConfiguration)	An asynchronous implementation of RoleType.writeCustomConfiguration(java.lang.Boolean).
void	writeEndpoints(org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[] value)	Write a new value for the Endpoints Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEndpointsAsync(org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[] endpoints)	An asynchronous implementation of RoleType.writeEndpoints(org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[]).
void	writeEndpointsExclude(Boolean value)	Write a new value for the EndpointsExclude Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEndpointsExcludeAsync(Boolean endpointsExclude)	An asynchronous implementation of RoleType.writeEndpointsExclude(java.lang.Boolean).
void	writeIdentities(org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[] value)	Write a new value for the Identities Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeIdentitiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[] identities)	An asynchronous implementation of RoleType.writeIdentities(org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[]).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode

callMethod, callMethod, callMethodAsync, callMethodAsync, getAttributeValue, getEventNotifier, getIconAsync, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersionAsync, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIconAsync, setNamingRuleAsync, setNodeVersionAsync, writeEventNotifier

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, writeUserWriteMask, writeWriteMask

Methods inherited from class java.lang.Object

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

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

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

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

getEventNotifier, setEventNotifier

Constructor Details

RoleTypeNode

public RoleTypeNode(OpcUaClient client,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
 org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass,
 org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Method Details

getIdentities

public org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[] getIdentities()
                                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the local value of the Identities Node.

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

Specified by:

getIdentities in interface RoleType

Returns:

the local value of the Identities Node.

Throws:

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

setIdentities

public void setIdentities(org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[] value)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Set the local value of the Identities Node.

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

Specified by:

setIdentities in interface RoleType

Parameters:

value - the local value to set for the Identities Node.

Throws:

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

readIdentities

public org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[] readIdentities()
                                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

readIdentities in interface RoleType

Returns:

the IdentityMappingRuleType value read from the server.

Throws:

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

writeIdentities

public void writeIdentities(org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[] value)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

writeIdentities in interface RoleType

Parameters:

value - the IdentityMappingRuleType value to write to the server.

Throws:

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

readIdentitiesAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[]> readIdentitiesAsync()

Description copied from interface: RoleType

An asynchronous implementation of RoleType.readIdentities().

Specified by:

readIdentitiesAsync in interface RoleType

Returns:

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

writeIdentitiesAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIdentitiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[] identities)

Description copied from interface: RoleType

An asynchronous implementation of RoleType.writeIdentities(org.eclipse.milo.opcua.stack.core.types.structured.IdentityMappingRuleType[]).

Specified by:

writeIdentitiesAsync in interface RoleType

Returns:

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

getIdentitiesNode

public PropertyTypeNode getIdentitiesNode()
                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the Identities PropertyType Node, or null if it does not exist.

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

Specified by:

getIdentitiesNode in interface RoleType

Returns:

the Identities PropertyType 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.

getIdentitiesNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getIdentitiesNodeAsync()

Description copied from interface: RoleType

Asynchronous implementation of RoleType.getIdentitiesNode().

Specified by:

getIdentitiesNodeAsync in interface RoleType

Returns:

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

getApplicationsExclude

public Boolean getApplicationsExclude()
                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the local value of the ApplicationsExclude Node.

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

Specified by:

getApplicationsExclude in interface RoleType

Returns:

the local value of the ApplicationsExclude Node.

Throws:

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

setApplicationsExclude

public void setApplicationsExclude(Boolean value)
                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Set the local value of the ApplicationsExclude Node.

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

Specified by:

setApplicationsExclude in interface RoleType

Parameters:

value - the local value to set for the ApplicationsExclude Node.

Throws:

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

readApplicationsExclude

public Boolean readApplicationsExclude()
                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

readApplicationsExclude in interface RoleType

Returns:

the Boolean value read from the server.

Throws:

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

writeApplicationsExclude

public void writeApplicationsExclude(Boolean value)
                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

writeApplicationsExclude in interface RoleType

Parameters:

value - the Boolean value to write to the server.

Throws:

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

readApplicationsExcludeAsync

public CompletableFuture<? extends Boolean> readApplicationsExcludeAsync()

Description copied from interface: RoleType

An asynchronous implementation of RoleType.readApplicationsExclude().

Specified by:

readApplicationsExcludeAsync in interface RoleType

Returns:

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

writeApplicationsExcludeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeApplicationsExcludeAsync(Boolean applicationsExclude)

Description copied from interface: RoleType

An asynchronous implementation of RoleType.writeApplicationsExclude(java.lang.Boolean).

Specified by:

writeApplicationsExcludeAsync in interface RoleType

Returns:

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

getApplicationsExcludeNode

public PropertyTypeNode getApplicationsExcludeNode()
                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the ApplicationsExclude PropertyType Node, or null if it does not exist.

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

Specified by:

getApplicationsExcludeNode in interface RoleType

Returns:

the ApplicationsExclude PropertyType 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.

getApplicationsExcludeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getApplicationsExcludeNodeAsync()

Description copied from interface: RoleType

Asynchronous implementation of RoleType.getApplicationsExcludeNode().

Specified by:

getApplicationsExcludeNodeAsync in interface RoleType

Returns:

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

getApplications

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

Description copied from interface: RoleType

Get the local value of the Applications Node.

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

Specified by:

getApplications in interface RoleType

Returns:

the local value of the Applications Node.

Throws:

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

setApplications

public void setApplications(String[] value)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Set the local value of the Applications Node.

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

Specified by:

setApplications in interface RoleType

Parameters:

value - the local value to set for the Applications Node.

Throws:

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

readApplications

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

Description copied from interface: RoleType

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

Specified by:

readApplications in interface RoleType

Returns:

the String value read from the server.

Throws:

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

writeApplications

public void writeApplications(String[] value)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

writeApplications in interface RoleType

Parameters:

value - the String value to write to the server.

Throws:

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

readApplicationsAsync

public CompletableFuture<? extends String[]> readApplicationsAsync()

Description copied from interface: RoleType

An asynchronous implementation of RoleType.readApplications().

Specified by:

readApplicationsAsync in interface RoleType

Returns:

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

writeApplicationsAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeApplicationsAsync(String[] applications)

Description copied from interface: RoleType

An asynchronous implementation of RoleType.writeApplications(java.lang.String[]).

Specified by:

writeApplicationsAsync in interface RoleType

Returns:

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

getApplicationsNode

public PropertyTypeNode getApplicationsNode()
                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the Applications PropertyType Node, or null if it does not exist.

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

Specified by:

getApplicationsNode in interface RoleType

Returns:

the Applications PropertyType 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.

getApplicationsNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getApplicationsNodeAsync()

Description copied from interface: RoleType

Asynchronous implementation of RoleType.getApplicationsNode().

Specified by:

getApplicationsNodeAsync in interface RoleType

Returns:

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

getEndpointsExclude

public Boolean getEndpointsExclude()
                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the local value of the EndpointsExclude Node.

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

Specified by:

getEndpointsExclude in interface RoleType

Returns:

the local value of the EndpointsExclude Node.

Throws:

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

setEndpointsExclude

public void setEndpointsExclude(Boolean value)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Set the local value of the EndpointsExclude Node.

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

Specified by:

setEndpointsExclude in interface RoleType

Parameters:

value - the local value to set for the EndpointsExclude Node.

Throws:

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

readEndpointsExclude

public Boolean readEndpointsExclude()
                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

readEndpointsExclude in interface RoleType

Returns:

the Boolean value read from the server.

Throws:

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

writeEndpointsExclude

public void writeEndpointsExclude(Boolean value)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

writeEndpointsExclude in interface RoleType

Parameters:

value - the Boolean value to write to the server.

Throws:

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

readEndpointsExcludeAsync

public CompletableFuture<? extends Boolean> readEndpointsExcludeAsync()

Description copied from interface: RoleType

An asynchronous implementation of RoleType.readEndpointsExclude().

Specified by:

readEndpointsExcludeAsync in interface RoleType

Returns:

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

writeEndpointsExcludeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEndpointsExcludeAsync(Boolean endpointsExclude)

Description copied from interface: RoleType

An asynchronous implementation of RoleType.writeEndpointsExclude(java.lang.Boolean).

Specified by:

writeEndpointsExcludeAsync in interface RoleType

Returns:

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

getEndpointsExcludeNode

public PropertyTypeNode getEndpointsExcludeNode()
                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the EndpointsExclude PropertyType Node, or null if it does not exist.

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

Specified by:

getEndpointsExcludeNode in interface RoleType

Returns:

the EndpointsExclude PropertyType 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.

getEndpointsExcludeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getEndpointsExcludeNodeAsync()

Description copied from interface: RoleType

Asynchronous implementation of RoleType.getEndpointsExcludeNode().

Specified by:

getEndpointsExcludeNodeAsync in interface RoleType

Returns:

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

getEndpoints

public org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[] getEndpoints()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the local value of the Endpoints Node.

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

Specified by:

getEndpoints in interface RoleType

Returns:

the local value of the Endpoints Node.

Throws:

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

setEndpoints

public void setEndpoints(org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[] value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Set the local value of the Endpoints Node.

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

Specified by:

setEndpoints in interface RoleType

Parameters:

value - the local value to set for the Endpoints Node.

Throws:

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

readEndpoints

public org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[] readEndpoints()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

readEndpoints in interface RoleType

Returns:

the EndpointType value read from the server.

Throws:

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

writeEndpoints

public void writeEndpoints(org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[] value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

writeEndpoints in interface RoleType

Parameters:

value - the EndpointType value to write to the server.

Throws:

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

readEndpointsAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[]> readEndpointsAsync()

Description copied from interface: RoleType

An asynchronous implementation of RoleType.readEndpoints().

Specified by:

readEndpointsAsync in interface RoleType

Returns:

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

writeEndpointsAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEndpointsAsync(org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[] endpoints)

Description copied from interface: RoleType

An asynchronous implementation of RoleType.writeEndpoints(org.eclipse.milo.opcua.stack.core.types.structured.EndpointType[]).

Specified by:

writeEndpointsAsync in interface RoleType

Returns:

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

getEndpointsNode

public PropertyTypeNode getEndpointsNode()
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the Endpoints PropertyType Node, or null if it does not exist.

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

Specified by:

getEndpointsNode in interface RoleType

Returns:

the Endpoints PropertyType 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.

getEndpointsNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getEndpointsNodeAsync()

Description copied from interface: RoleType

Asynchronous implementation of RoleType.getEndpointsNode().

Specified by:

getEndpointsNodeAsync in interface RoleType

Returns:

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

getCustomConfiguration

public Boolean getCustomConfiguration()
                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the local value of the CustomConfiguration Node.

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

Specified by:

getCustomConfiguration in interface RoleType

Returns:

the local value of the CustomConfiguration Node.

Throws:

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

setCustomConfiguration

public void setCustomConfiguration(Boolean value)
                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Set the local value of the CustomConfiguration Node.

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

Specified by:

setCustomConfiguration in interface RoleType

Parameters:

value - the local value to set for the CustomConfiguration Node.

Throws:

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

readCustomConfiguration

public Boolean readCustomConfiguration()
                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

readCustomConfiguration in interface RoleType

Returns:

the Boolean value read from the server.

Throws:

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

writeCustomConfiguration

public void writeCustomConfiguration(Boolean value)
                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

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

Specified by:

writeCustomConfiguration in interface RoleType

Parameters:

value - the Boolean value to write to the server.

Throws:

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

readCustomConfigurationAsync

public CompletableFuture<? extends Boolean> readCustomConfigurationAsync()

Description copied from interface: RoleType

An asynchronous implementation of RoleType.readCustomConfiguration().

Specified by:

readCustomConfigurationAsync in interface RoleType

Returns:

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

writeCustomConfigurationAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCustomConfigurationAsync(Boolean customConfiguration)

Description copied from interface: RoleType

An asynchronous implementation of RoleType.writeCustomConfiguration(java.lang.Boolean).

Specified by:

writeCustomConfigurationAsync in interface RoleType

Returns:

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

getCustomConfigurationNode

public PropertyTypeNode getCustomConfigurationNode()
                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RoleType

Get the CustomConfiguration PropertyType Node, or null if it does not exist.

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

Specified by:

getCustomConfigurationNode in interface RoleType

Returns:

the CustomConfiguration PropertyType 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.

getCustomConfigurationNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getCustomConfigurationNodeAsync()

Description copied from interface: RoleType

Asynchronous implementation of RoleType.getCustomConfigurationNode().

Specified by:

getCustomConfigurationNodeAsync in interface RoleType

Returns:

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