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

Interface FileType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Subinterfaces:
AddressSpaceFileType, PubSubConfigurationType, TrustListType
All Known Implementing Classes:
AddressSpaceFileTypeNode, FileTypeNode, PubSubConfigurationTypeNode, TrustListTypeNode
public interface FileType extends BaseObjectType
See Also:

  • Field Details

    • SIZE

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

    • WRITABLE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> WRITABLE

    • USER_WRITABLE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> USER_WRITABLE

    • OPEN_COUNT

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

    • MIME_TYPE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> MIME_TYPE

    • MAX_BYTE_STRING_LENGTH

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> MAX_BYTE_STRING_LENGTH

    • LAST_MODIFIED_TIME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> LAST_MODIFIED_TIME

  • Method Details

    • 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 value) 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:
      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

      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 value) 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:
      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

      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 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 value)
      An asynchronous implementation of writeSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.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 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 value) 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:
      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

      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 value) 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:
      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

      CompletableFuture<? extends Boolean> readWritableAsync()
      An asynchronous implementation of readWritable().
      Returns:
      a CompletableFuture that completes successfully with the 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 value)
      An asynchronous implementation of writeWritable(java.lang.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 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 value) 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:
      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

      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 value) 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:
      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

      CompletableFuture<? extends Boolean> readUserWritableAsync()
      An asynchronous implementation of readUserWritable().
      Returns:
      a CompletableFuture that completes successfully with the 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 value)
      An asynchronous implementation of writeUserWritable(java.lang.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 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 value) 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:
      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

      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 value) 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:
      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

      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 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 value)
      An asynchronous implementation of writeOpenCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.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 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 value) 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:
      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

      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 value) 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:
      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

      CompletableFuture<? extends String> readMimeTypeAsync()
      An asynchronous implementation of readMimeType().
      Returns:
      a CompletableFuture that completes successfully with the 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 value)
      An asynchronous implementation of writeMimeType(java.lang.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 PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getMaxByteStringLength

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxByteStringLength() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the MaxByteStringLength Node.

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

      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

      void setMaxByteStringLength(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the MaxByteStringLength Node.

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

      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

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readMaxByteStringLength() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the MaxByteStringLength Node from the server and update the local value if the operation succeeds.
      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

      void writeMaxByteStringLength(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the MaxByteStringLength Node to the server and update the local value if the operation succeeds.
      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

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readMaxByteStringLengthAsync()
      An asynchronous implementation of readMaxByteStringLength().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeMaxByteStringLengthAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMaxByteStringLengthAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
      An asynchronous implementation of writeMaxByteStringLength(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getMaxByteStringLengthNode

      PropertyType getMaxByteStringLengthNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the MaxByteStringLength PropertyType Node, or null if it does not exist.

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

      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

      CompletableFuture<? extends PropertyType> getMaxByteStringLengthNodeAsync()
      Asynchronous implementation of getMaxByteStringLengthNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getLastModifiedTime

      org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getLastModifiedTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the LastModifiedTime Node.

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

      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

      void setLastModifiedTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the LastModifiedTime Node.

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

      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

      org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readLastModifiedTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the LastModifiedTime Node from the server and update the local value if the operation succeeds.
      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

      void writeLastModifiedTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the LastModifiedTime Node to the server and update the local value if the operation succeeds.
      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

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readLastModifiedTimeAsync()
      An asynchronous implementation of readLastModifiedTime().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeLastModifiedTimeAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLastModifiedTimeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value)
      An asynchronous implementation of writeLastModifiedTime(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getLastModifiedTimeNode

      PropertyType getLastModifiedTimeNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the LastModifiedTime PropertyType Node, or null if it does not exist.

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

      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

      CompletableFuture<? extends PropertyType> getLastModifiedTimeNodeAsync()
      Asynchronous implementation of getLastModifiedTimeNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.