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

Interface FileType

All Superinterfaces:

BaseObjectType, Node, ObjectNode

All Known Subinterfaces:

AddressSpaceFileType, TrustListType

All Known Implementing Classes:

AddressSpaceFileTypeNode, FileTypeNode, TrustListTypeNode

public interface FileType
extends BaseObjectType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<String>	MIME_TYPE
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort>	OPEN_COUNT
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong>	SIZE
static QualifiedProperty<Boolean>	USER_WRITABLE
static QualifiedProperty<Boolean>	WRITABLE

Method Summary

Modifier and Type	Method and Description
String	getMimeType() Get the local value of the MimeType Node.
PropertyType	getMimeTypeNode() Get the MimeType PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getMimeTypeNodeAsync() Asynchronous implementation of getMimeTypeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	getOpenCount() Get the local value of the OpenCount Node.
PropertyType	getOpenCountNode() Get the OpenCount PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getOpenCountNodeAsync() Asynchronous implementation of getOpenCountNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong	getSize() Get the local value of the Size Node.
PropertyType	getSizeNode() Get the Size PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getSizeNodeAsync() Asynchronous implementation of getSizeNode().
Boolean	getUserWritable() Get the local value of the UserWritable Node.
PropertyType	getUserWritableNode() Get the UserWritable PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getUserWritableNodeAsync() Asynchronous implementation of getUserWritableNode().
Boolean	getWritable() Get the local value of the Writable Node.
PropertyType	getWritableNode() Get the Writable PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getWritableNodeAsync() Asynchronous implementation of getWritableNode().
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 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 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 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 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 readWritable().
void	setMimeType(String mimeType) Set the local value of the MimeType Node.
void	setOpenCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort openCount) Set the local value of the OpenCount Node.
void	setSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong size) Set the local value of the Size Node.
void	setUserWritable(Boolean userWritable) Set the local value of the UserWritable Node.
void	setWritable(Boolean writable) Set the local value of the Writable Node.
void	writeMimeType(String mimeType) 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 writeMimeType(String).
void	writeOpenCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort openCount) 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 writeOpenCount(UShort).
void	writeSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong size) 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 writeSize(ULong).
void	writeUserWritable(Boolean userWritable) 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 writeUserWritable(Boolean).
void	writeWritable(Boolean writable) 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 writeWritable(Boolean).

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

getEventNotifier, setEventNotifier

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

Field Detail

SIZE

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.ULong> SIZE

WRITABLE

static final QualifiedProperty<Boolean> WRITABLE

USER_WRITABLE

static final QualifiedProperty<Boolean> USER_WRITABLE

OPEN_COUNT

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> OPEN_COUNT

MIME_TYPE

static final QualifiedProperty<String> MIME_TYPE

Method Detail

getSize

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

Get the local value of the Size Node.

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

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

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

Set the local value of the Size Node.

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

Parameters:

size - 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

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

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

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

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

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

Parameters:

size - 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

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

An asynchronous implementation of readSize().

Returns:

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

writeSizeAsync

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 writeSize(ULong).

Returns:

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

getSizeNode

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

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

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

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

CompletableFuture<? extends PropertyType> getSizeNodeAsync()

Asynchronous implementation of getSizeNode().

Returns:

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

getWritable

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

Get the local value of the Writable Node.

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

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

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

Set the local value of the Writable Node.

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

Parameters:

writable - 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

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

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

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

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

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

Parameters:

writable - 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

CompletableFuture<? extends Boolean> readWritableAsync()

An asynchronous implementation of readWritable().

Returns:

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

writeWritableAsync

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

An asynchronous implementation of writeWritable(Boolean).

Returns:

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

getWritableNode

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

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

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

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

CompletableFuture<? extends PropertyType> getWritableNodeAsync()

Asynchronous implementation of getWritableNode().

Returns:

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

getUserWritable

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

Get the local value of the UserWritable Node.

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

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

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

Set the local value of the UserWritable Node.

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

Parameters:

userWritable - 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

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

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

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

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

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

Parameters:

userWritable - 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

CompletableFuture<? extends Boolean> readUserWritableAsync()

An asynchronous implementation of readUserWritable().

Returns:

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

writeUserWritableAsync

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

An asynchronous implementation of writeUserWritable(Boolean).

Returns:

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

getUserWritableNode

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

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

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

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

CompletableFuture<? extends PropertyType> getUserWritableNodeAsync()

Asynchronous implementation of getUserWritableNode().

Returns:

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

getOpenCount

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

Get the local value of the OpenCount Node.

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

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

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

Set the local value of the OpenCount Node.

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

Parameters:

openCount - 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

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

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

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

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

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

Parameters:

openCount - 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

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

An asynchronous implementation of readOpenCount().

Returns:

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

writeOpenCountAsync

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 writeOpenCount(UShort).

Returns:

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

getOpenCountNode

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

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

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

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

CompletableFuture<? extends PropertyType> getOpenCountNodeAsync()

Asynchronous implementation of getOpenCountNode().

Returns:

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

getMimeType

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

Get the local value of the MimeType Node.

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

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

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

Set the local value of the MimeType Node.

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

Parameters:

mimeType - 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

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

Read the value of the MimeType 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.

writeMimeType

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

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

Parameters:

mimeType - 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

CompletableFuture<? extends String> readMimeTypeAsync()

An asynchronous implementation of readMimeType().

Returns:

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

writeMimeTypeAsync

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

An asynchronous implementation of writeMimeType(String).

Returns:

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

getMimeTypeNode

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

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

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

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

CompletableFuture<? extends PropertyType> getMimeTypeNodeAsync()

Asynchronous implementation of getMimeTypeNode().

Returns:

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