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

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

Class FileTypeNode

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.FileTypeNode

All Implemented Interfaces:

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

Direct Known Subclasses:

AddressSpaceFileTypeNode, PubSubConfigurationTypeNode, TrustListTypeNode

public class FileTypeNode
extends BaseObjectTypeNode
implements FileType

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.FileType

LAST_MODIFIED_TIME, MAX_BYTE_STRING_LENGTH, MIME_TYPE, OPEN_COUNT, SIZE, USER_WRITABLE, WRITABLE

Constructor Summary

Constructors

Constructor

Description

FileTypeNode(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
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	getLastModifiedTime()	Get the local value of the LastModifiedTime Node.
PropertyTypeNode	getLastModifiedTimeNode()	Get the LastModifiedTime PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getLastModifiedTimeNodeAsync()	Asynchronous implementation of FileType.getLastModifiedTimeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getMaxByteStringLength()	Get the local value of the MaxByteStringLength Node.
PropertyTypeNode	getMaxByteStringLengthNode()	Get the MaxByteStringLength PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getMaxByteStringLengthNodeAsync()	Asynchronous implementation of FileType.getMaxByteStringLengthNode().
String	getMimeType()	Get the local value of the MimeType Node.
PropertyTypeNode	getMimeTypeNode()	Get the MimeType PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getMimeTypeNodeAsync()	Asynchronous implementation of FileType.getMimeTypeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	getOpenCount()	Get the local value of the OpenCount Node.
PropertyTypeNode	getOpenCountNode()	Get the OpenCount PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getOpenCountNodeAsync()	Asynchronous implementation of FileType.getOpenCountNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong	getSize()	Get the local value of the Size Node.
PropertyTypeNode	getSizeNode()	Get the Size PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSizeNodeAsync()	Asynchronous implementation of FileType.getSizeNode().
Boolean	getUserWritable()	Get the local value of the UserWritable Node.
PropertyTypeNode	getUserWritableNode()	Get the UserWritable PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getUserWritableNodeAsync()	Asynchronous implementation of FileType.getUserWritableNode().
Boolean	getWritable()	Get the local value of the Writable Node.
PropertyTypeNode	getWritableNode()	Get the Writable PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getWritableNodeAsync()	Asynchronous implementation of FileType.getWritableNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	readLastModifiedTime()	Read the value of the LastModifiedTime Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	readLastModifiedTimeAsync()	An asynchronous implementation of FileType.readLastModifiedTime().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readMaxByteStringLength()	Read the value of the MaxByteStringLength Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readMaxByteStringLengthAsync()	An asynchronous implementation of FileType.readMaxByteStringLength().
String	readMimeType()	Read the value of the MimeType Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readMimeTypeAsync()	An asynchronous implementation of FileType.readMimeType().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	readOpenCount()	Read the value of the OpenCount Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort>	readOpenCountAsync()	An asynchronous implementation of FileType.readOpenCount().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong	readSize()	Read the value of the Size Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong>	readSizeAsync()	An asynchronous implementation of FileType.readSize().
Boolean	readUserWritable()	Read the value of the UserWritable Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readUserWritableAsync()	An asynchronous implementation of FileType.readUserWritable().
Boolean	readWritable()	Read the value of the Writable Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readWritableAsync()	An asynchronous implementation of FileType.readWritable().
void	setLastModifiedTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value)	Set the local value of the LastModifiedTime Node.
void	setMaxByteStringLength(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Set the local value of the MaxByteStringLength Node.
void	setMimeType(String value)	Set the local value of the MimeType Node.
void	setOpenCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)	Set the local value of the OpenCount Node.
void	setSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong value)	Set the local value of the Size Node.
void	setUserWritable(Boolean value)	Set the local value of the UserWritable Node.
void	setWritable(Boolean value)	Set the local value of the Writable Node.
void	writeLastModifiedTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value)	Write a new value for the LastModifiedTime Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLastModifiedTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime lastModifiedTime)	An asynchronous implementation of FileType.writeLastModifiedTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime).
void	writeMaxByteStringLength(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Write a new value for the MaxByteStringLength Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMaxByteStringLengthAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxByteStringLength)	An asynchronous implementation of FileType.writeMaxByteStringLength(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).
void	writeMimeType(String value)	Write a new value for the MimeType Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMimeTypeAsync(String mimeType)	An asynchronous implementation of FileType.writeMimeType(java.lang.String).
void	writeOpenCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)	Write a new value for the OpenCount Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeOpenCountAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort openCount)	An asynchronous implementation of FileType.writeOpenCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).
void	writeSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong value)	Write a new value for the Size Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong size)	An asynchronous implementation of FileType.writeSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong).
void	writeUserWritable(Boolean value)	Write a new value for the UserWritable Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeUserWritableAsync(Boolean userWritable)	An asynchronous implementation of FileType.writeUserWritable(java.lang.Boolean).
void	writeWritable(Boolean value)	Write a new value for the Writable Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeWritableAsync(Boolean writable)	An asynchronous implementation of FileType.writeWritable(java.lang.Boolean).

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

FileTypeNode

public FileTypeNode(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

getSize

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong getSize()
                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

Get the local value of the Size Node.

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

Specified by:

getSize in interface FileType

Returns:

the local value of the Size Node.

Throws:

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

setSize

public void setSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong value)
             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

Set the local value of the Size Node.

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

Specified by:

setSize in interface FileType

Parameters:

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

Throws:

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

readSize

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong readSize()
                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

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

Specified by:

readSize in interface FileType

Returns:

the ULong value read from the server.

Throws:

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

writeSize

public void writeSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong value)
               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

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

Specified by:

writeSize in interface FileType

Parameters:

value - the ULong value to write to the server.

Throws:

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

readSizeAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong> readSizeAsync()

Description copied from interface: FileType

An asynchronous implementation of FileType.readSize().

Specified by:

readSizeAsync in interface FileType

Returns:

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

writeSizeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong size)

Description copied from interface: FileType

An asynchronous implementation of FileType.writeSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong).

Specified by:

writeSizeAsync in interface FileType

Returns:

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

getSizeNode

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

Description copied from interface: FileType

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

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

Specified by:

getSizeNode in interface FileType

Returns:

the Size 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.

getSizeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getSizeNodeAsync()

Description copied from interface: FileType

Asynchronous implementation of FileType.getSizeNode().

Specified by:

getSizeNodeAsync in interface FileType

Returns:

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

getWritable

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

Description copied from interface: FileType

Get the local value of the Writable Node.

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

Specified by:

getWritable in interface FileType

Returns:

the local value of the Writable Node.

Throws:

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

setWritable

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

Description copied from interface: FileType

Set the local value of the Writable Node.

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

Specified by:

setWritable in interface FileType

Parameters:

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

Throws:

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

readWritable

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

Description copied from interface: FileType

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

Specified by:

readWritable in interface FileType

Returns:

the Boolean value read from the server.

Throws:

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

writeWritable

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

Description copied from interface: FileType

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

Specified by:

writeWritable in interface FileType

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.

readWritableAsync

public CompletableFuture<? extends Boolean> readWritableAsync()

Description copied from interface: FileType

An asynchronous implementation of FileType.readWritable().

Specified by:

readWritableAsync in interface FileType

Returns:

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

writeWritableAsync

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

Description copied from interface: FileType

An asynchronous implementation of FileType.writeWritable(java.lang.Boolean).

Specified by:

writeWritableAsync in interface FileType

Returns:

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

getWritableNode

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

Description copied from interface: FileType

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

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

Specified by:

getWritableNode in interface FileType

Returns:

the Writable 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.

getWritableNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getWritableNodeAsync()

Description copied from interface: FileType

Asynchronous implementation of FileType.getWritableNode().

Specified by:

getWritableNodeAsync in interface FileType

Returns:

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

getUserWritable

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

Description copied from interface: FileType

Get the local value of the UserWritable Node.

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

Specified by:

getUserWritable in interface FileType

Returns:

the local value of the UserWritable Node.

Throws:

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

setUserWritable

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

Description copied from interface: FileType

Set the local value of the UserWritable Node.

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

Specified by:

setUserWritable in interface FileType

Parameters:

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

Throws:

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

readUserWritable

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

Description copied from interface: FileType

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

Specified by:

readUserWritable in interface FileType

Returns:

the Boolean value read from the server.

Throws:

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

writeUserWritable

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

Description copied from interface: FileType

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

Specified by:

writeUserWritable in interface FileType

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.

readUserWritableAsync

public CompletableFuture<? extends Boolean> readUserWritableAsync()

Description copied from interface: FileType

An asynchronous implementation of FileType.readUserWritable().

Specified by:

readUserWritableAsync in interface FileType

Returns:

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

writeUserWritableAsync

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

Description copied from interface: FileType

An asynchronous implementation of FileType.writeUserWritable(java.lang.Boolean).

Specified by:

writeUserWritableAsync in interface FileType

Returns:

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

getUserWritableNode

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

Description copied from interface: FileType

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

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

Specified by:

getUserWritableNode in interface FileType

Returns:

the UserWritable 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.

getUserWritableNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getUserWritableNodeAsync()

Description copied from interface: FileType

Asynchronous implementation of FileType.getUserWritableNode().

Specified by:

getUserWritableNodeAsync in interface FileType

Returns:

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

getOpenCount

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getOpenCount()
                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

Get the local value of the OpenCount Node.

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

Specified by:

getOpenCount in interface FileType

Returns:

the local value of the OpenCount Node.

Throws:

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

setOpenCount

public void setOpenCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

Set the local value of the OpenCount Node.

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

Specified by:

setOpenCount in interface FileType

Parameters:

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

Throws:

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

readOpenCount

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort readOpenCount()
                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

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

Specified by:

readOpenCount in interface FileType

Returns:

the UShort value read from the server.

Throws:

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

writeOpenCount

public void writeOpenCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

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

Specified by:

writeOpenCount in interface FileType

Parameters:

value - the UShort value to write to the server.

Throws:

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

readOpenCountAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> readOpenCountAsync()

Description copied from interface: FileType

An asynchronous implementation of FileType.readOpenCount().

Specified by:

readOpenCountAsync in interface FileType

Returns:

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

writeOpenCountAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeOpenCountAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort openCount)

Description copied from interface: FileType

An asynchronous implementation of FileType.writeOpenCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).

Specified by:

writeOpenCountAsync in interface FileType

Returns:

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

getOpenCountNode

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

Description copied from interface: FileType

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

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

Specified by:

getOpenCountNode in interface FileType

Returns:

the OpenCount 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.

getOpenCountNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getOpenCountNodeAsync()

Description copied from interface: FileType

Asynchronous implementation of FileType.getOpenCountNode().

Specified by:

getOpenCountNodeAsync in interface FileType

Returns:

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

getMimeType

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

Description copied from interface: FileType

Get the local value of the MimeType Node.

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

Specified by:

getMimeType in interface FileType

Returns:

the local value of the MimeType Node.

Throws:

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

setMimeType

public void setMimeType(String value)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

Set the local value of the MimeType Node.

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

Specified by:

setMimeType in interface FileType

Parameters:

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

Throws:

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

readMimeType

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

Description copied from interface: FileType

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

Specified by:

readMimeType in interface FileType

Returns:

the String value read from the server.

Throws:

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

writeMimeType

public void writeMimeType(String value)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

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

Specified by:

writeMimeType in interface FileType

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.

readMimeTypeAsync

public CompletableFuture<? extends String> readMimeTypeAsync()

Description copied from interface: FileType

An asynchronous implementation of FileType.readMimeType().

Specified by:

readMimeTypeAsync in interface FileType

Returns:

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

writeMimeTypeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMimeTypeAsync(String mimeType)

Description copied from interface: FileType

An asynchronous implementation of FileType.writeMimeType(java.lang.String).

Specified by:

writeMimeTypeAsync in interface FileType

Returns:

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

getMimeTypeNode

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

Description copied from interface: FileType

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

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

Specified by:

getMimeTypeNode in interface FileType

Returns:

the MimeType 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.

getMimeTypeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getMimeTypeNodeAsync()

Description copied from interface: FileType

Asynchronous implementation of FileType.getMimeTypeNode().

Specified by:

getMimeTypeNodeAsync in interface FileType

Returns:

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

getMaxByteStringLength

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxByteStringLength()
                                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

Get the local value of the MaxByteStringLength Node.

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

Specified by:

getMaxByteStringLength in interface FileType

Returns:

the local value of the MaxByteStringLength Node.

Throws:

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

setMaxByteStringLength

public void setMaxByteStringLength(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

Set the local value of the MaxByteStringLength Node.

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

Specified by:

setMaxByteStringLength in interface FileType

Parameters:

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

Throws:

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

readMaxByteStringLength

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readMaxByteStringLength()
                                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

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

Specified by:

readMaxByteStringLength in interface FileType

Returns:

the UInteger value read from the server.

Throws:

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

writeMaxByteStringLength

public void writeMaxByteStringLength(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

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

Specified by:

writeMaxByteStringLength in interface FileType

Parameters:

value - the UInteger value to write to the server.

Throws:

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

readMaxByteStringLengthAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readMaxByteStringLengthAsync()

Description copied from interface: FileType

An asynchronous implementation of FileType.readMaxByteStringLength().

Specified by:

readMaxByteStringLengthAsync in interface FileType

Returns:

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

writeMaxByteStringLengthAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMaxByteStringLengthAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxByteStringLength)

Description copied from interface: FileType

An asynchronous implementation of FileType.writeMaxByteStringLength(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

Specified by:

writeMaxByteStringLengthAsync in interface FileType

Returns:

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

getMaxByteStringLengthNode

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

Description copied from interface: FileType

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

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

Specified by:

getMaxByteStringLengthNode in interface FileType

Returns:

the MaxByteStringLength 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.

getMaxByteStringLengthNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getMaxByteStringLengthNodeAsync()

Description copied from interface: FileType

Asynchronous implementation of FileType.getMaxByteStringLengthNode().

Specified by:

getMaxByteStringLengthNodeAsync in interface FileType

Returns:

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

getLastModifiedTime

public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getLastModifiedTime()
                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

Get the local value of the LastModifiedTime Node.

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

Specified by:

getLastModifiedTime in interface FileType

Returns:

the local value of the LastModifiedTime Node.

Throws:

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

setLastModifiedTime

public void setLastModifiedTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

Set the local value of the LastModifiedTime Node.

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

Specified by:

setLastModifiedTime in interface FileType

Parameters:

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

Throws:

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

readLastModifiedTime

public org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readLastModifiedTime()
                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

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

Specified by:

readLastModifiedTime in interface FileType

Returns:

the DateTime value read from the server.

Throws:

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

writeLastModifiedTime

public void writeLastModifiedTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: FileType

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

Specified by:

writeLastModifiedTime in interface FileType

Parameters:

value - the DateTime value to write to the server.

Throws:

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

readLastModifiedTimeAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readLastModifiedTimeAsync()

Description copied from interface: FileType

An asynchronous implementation of FileType.readLastModifiedTime().

Specified by:

readLastModifiedTimeAsync in interface FileType

Returns:

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

writeLastModifiedTimeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLastModifiedTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime lastModifiedTime)

Description copied from interface: FileType

An asynchronous implementation of FileType.writeLastModifiedTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime).

Specified by:

writeLastModifiedTimeAsync in interface FileType

Returns:

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

getLastModifiedTimeNode

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

Description copied from interface: FileType

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

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

Specified by:

getLastModifiedTimeNode in interface FileType

Returns:

the LastModifiedTime 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.

getLastModifiedTimeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getLastModifiedTimeNodeAsync()

Description copied from interface: FileType

Asynchronous implementation of FileType.getLastModifiedTimeNode().

Specified by:

getLastModifiedTimeNodeAsync in interface FileType

Returns:

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