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

Interface HistoricalExternalEventSourceType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
HistoricalExternalEventSourceTypeNode
public interface HistoricalExternalEventSourceType extends BaseObjectType
See Also:

  • Field Details

    • SERVER

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

    • ENDPOINT_URL

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

    • SECURITY_MODE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode> SECURITY_MODE

    • SECURITY_POLICY_URI

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

    • IDENTITY_TOKEN_POLICY

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.UserTokenPolicy> IDENTITY_TOKEN_POLICY

    • TRANSPORT_PROFILE_URI

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

    • HISTORICAL_EVENT_FILTER

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.EventFilter> HISTORICAL_EVENT_FILTER

  • Method Details

    • getServer

      String getServer() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Server Node.

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

      Returns:
      the local value of the Server Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Server Node.

    • setServer

      void setServer(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Server Node.

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

      Parameters:
      value - the local value to set for the Server Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Server Node.

    • readServer

      String readServer() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the Server 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.

    • writeServer

      void writeServer(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the Server 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.

    • readServerAsync

      CompletableFuture<? extends String> readServerAsync()
      An asynchronous implementation of readServer().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeServerAsync

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

    • getServerNode

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

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

      Returns:
      the Server 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.

    • getServerNodeAsync

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

    • getEndpointUrl

      String getEndpointUrl() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the EndpointUrl Node.

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

      Returns:
      the local value of the EndpointUrl Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the EndpointUrl Node.

    • setEndpointUrl

      void setEndpointUrl(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the EndpointUrl Node.

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

      Parameters:
      value - the local value to set for the EndpointUrl Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the EndpointUrl Node.

    • readEndpointUrl

      String readEndpointUrl() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the EndpointUrl 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.

    • writeEndpointUrl

      void writeEndpointUrl(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the EndpointUrl 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.

    • readEndpointUrlAsync

      CompletableFuture<? extends String> readEndpointUrlAsync()
      An asynchronous implementation of readEndpointUrl().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeEndpointUrlAsync

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

    • getEndpointUrlNode

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

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

      Returns:
      the EndpointUrl 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.

    • getEndpointUrlNodeAsync

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

    • getSecurityMode

      org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode getSecurityMode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SecurityMode Node.

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

      Returns:
      the local value of the SecurityMode Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityMode Node.

    • setSecurityMode

      void setSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SecurityMode Node.

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

      Parameters:
      value - the local value to set for the SecurityMode Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityMode Node.

    • readSecurityMode

      org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode readSecurityMode() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the SecurityMode Node from the server and update the local value if the operation succeeds.
      Returns:
      the MessageSecurityMode value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeSecurityMode

      void writeSecurityMode(org.eclipse.milo.opcua.stack.core.types.enumerated.MessageSecurityMode value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the SecurityMode Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the MessageSecurityMode value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readSecurityModeAsync

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

    • writeSecurityModeAsync

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

    • getSecurityModeNode

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

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

      Returns:
      the SecurityMode 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.

    • getSecurityModeNodeAsync

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

    • getSecurityPolicyUri

      String getSecurityPolicyUri() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SecurityPolicyUri Node.

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

      Returns:
      the local value of the SecurityPolicyUri Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityPolicyUri Node.

    • setSecurityPolicyUri

      void setSecurityPolicyUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SecurityPolicyUri Node.

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

      Parameters:
      value - the local value to set for the SecurityPolicyUri Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SecurityPolicyUri Node.

    • readSecurityPolicyUri

      String readSecurityPolicyUri() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the SecurityPolicyUri Node from the server and update the local value if the operation succeeds.
      Returns:
      the String value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeSecurityPolicyUri

      void writeSecurityPolicyUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the SecurityPolicyUri Node to the server and update the local value if the operation succeeds.
      Parameters:
      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.

    • readSecurityPolicyUriAsync

      CompletableFuture<? extends String> readSecurityPolicyUriAsync()
      An asynchronous implementation of readSecurityPolicyUri().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeSecurityPolicyUriAsync

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

    • getSecurityPolicyUriNode

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

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

      Returns:
      the SecurityPolicyUri 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.

    • getSecurityPolicyUriNodeAsync

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

    • getIdentityTokenPolicy

      org.eclipse.milo.opcua.stack.core.types.structured.UserTokenPolicy getIdentityTokenPolicy() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the IdentityTokenPolicy Node.

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

      Returns:
      the local value of the IdentityTokenPolicy Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the IdentityTokenPolicy Node.

    • setIdentityTokenPolicy

      void setIdentityTokenPolicy(org.eclipse.milo.opcua.stack.core.types.structured.UserTokenPolicy value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the IdentityTokenPolicy Node.

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

      Parameters:
      value - the local value to set for the IdentityTokenPolicy Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the IdentityTokenPolicy Node.

    • readIdentityTokenPolicy

      org.eclipse.milo.opcua.stack.core.types.structured.UserTokenPolicy readIdentityTokenPolicy() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the IdentityTokenPolicy Node from the server and update the local value if the operation succeeds.
      Returns:
      the UserTokenPolicy value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeIdentityTokenPolicy

      void writeIdentityTokenPolicy(org.eclipse.milo.opcua.stack.core.types.structured.UserTokenPolicy value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the IdentityTokenPolicy Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the UserTokenPolicy value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readIdentityTokenPolicyAsync

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

    • writeIdentityTokenPolicyAsync

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

    • getIdentityTokenPolicyNode

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

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

      Returns:
      the IdentityTokenPolicy 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.

    • getIdentityTokenPolicyNodeAsync

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

    • getTransportProfileUri

      String getTransportProfileUri() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the TransportProfileUri Node.

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

      Returns:
      the local value of the TransportProfileUri Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the TransportProfileUri Node.

    • setTransportProfileUri

      void setTransportProfileUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the TransportProfileUri Node.

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

      Parameters:
      value - the local value to set for the TransportProfileUri Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the TransportProfileUri Node.

    • readTransportProfileUri

      String readTransportProfileUri() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the TransportProfileUri 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.

    • writeTransportProfileUri

      void writeTransportProfileUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the TransportProfileUri 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.

    • readTransportProfileUriAsync

      CompletableFuture<? extends String> readTransportProfileUriAsync()
      An asynchronous implementation of readTransportProfileUri().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeTransportProfileUriAsync

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

    • getTransportProfileUriNode

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

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

      Returns:
      the TransportProfileUri 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.

    • getTransportProfileUriNodeAsync

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

    • getHistoricalEventFilter

      org.eclipse.milo.opcua.stack.core.types.structured.EventFilter getHistoricalEventFilter() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the HistoricalEventFilter Node.

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

      Returns:
      the local value of the HistoricalEventFilter Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the HistoricalEventFilter Node.

    • setHistoricalEventFilter

      void setHistoricalEventFilter(org.eclipse.milo.opcua.stack.core.types.structured.EventFilter value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the HistoricalEventFilter Node.

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

      Parameters:
      value - the local value to set for the HistoricalEventFilter Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the HistoricalEventFilter Node.

    • readHistoricalEventFilter

      org.eclipse.milo.opcua.stack.core.types.structured.EventFilter readHistoricalEventFilter() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the HistoricalEventFilter Node from the server and update the local value if the operation succeeds.
      Returns:
      the EventFilter value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeHistoricalEventFilter

      void writeHistoricalEventFilter(org.eclipse.milo.opcua.stack.core.types.structured.EventFilter value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the HistoricalEventFilter Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the EventFilter value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readHistoricalEventFilterAsync

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

    • writeHistoricalEventFilterAsync

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

    • getHistoricalEventFilterNode

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

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

      Returns:
      the HistoricalEventFilter 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.

    • getHistoricalEventFilterNodeAsync

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