Interface AuditOpenSecureChannelEventType

All Superinterfaces:
AuditChannelEventType, AuditEventType, AuditSecurityEventType, BaseEventType, BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
AuditOpenSecureChannelEventTypeNode

public interface AuditOpenSecureChannelEventType extends AuditChannelEventType
See Also:
  • Field Details

    • CLIENT_CERTIFICATE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> CLIENT_CERTIFICATE
    • CLIENT_CERTIFICATE_THUMBPRINT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> CLIENT_CERTIFICATE_THUMBPRINT
    • REQUEST_TYPE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.SecurityTokenRequestType> REQUEST_TYPE
    • SECURITY_POLICY_URI

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

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

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Double> REQUESTED_LIFETIME
    • CERTIFICATE_ERROR_EVENT_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> CERTIFICATE_ERROR_EVENT_ID
  • Method Details

    • getClientCertificate

      org.eclipse.milo.opcua.stack.core.types.builtin.ByteString getClientCertificate() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ClientCertificate Node.

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

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

      void setClientCertificate(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ClientCertificate Node.

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

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

      org.eclipse.milo.opcua.stack.core.types.builtin.ByteString readClientCertificate() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ClientCertificate Node from the server and update the local value if the operation succeeds.
      Returns:
      the ByteString value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writeClientCertificate

      void writeClientCertificate(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ClientCertificate Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the ByteString value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • readClientCertificateAsync

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

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeClientCertificateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getClientCertificateNode

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

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

      Returns:
      the ClientCertificate 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.
    • getClientCertificateNodeAsync

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

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

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

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

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

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

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

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

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

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

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

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

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

      Returns:
      the ClientCertificateThumbprint 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.
    • getClientCertificateThumbprintNodeAsync

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

      org.eclipse.milo.opcua.stack.core.types.enumerated.SecurityTokenRequestType getRequestType() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the RequestType Node.

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

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

      void setRequestType(org.eclipse.milo.opcua.stack.core.types.enumerated.SecurityTokenRequestType value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the RequestType Node.

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

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

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

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

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

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRequestTypeAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.SecurityTokenRequestType value)
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getRequestTypeNode

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

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

      Returns:
      the RequestType 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.
    • getRequestTypeNodeAsync

      CompletableFuture<? extends PropertyType> getRequestTypeNodeAsync()
      Asynchronous implementation of getRequestTypeNode().
      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.
    • 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)
      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.
    • getRequestedLifetime

      Double getRequestedLifetime() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the RequestedLifetime Node.

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

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

      void setRequestedLifetime(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the RequestedLifetime Node.

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

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

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

      void writeRequestedLifetime(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the RequestedLifetime Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the Double value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • readRequestedLifetimeAsync

      CompletableFuture<? extends Double> readRequestedLifetimeAsync()
      An asynchronous implementation of readRequestedLifetime().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.
    • writeRequestedLifetimeAsync

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

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

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

      Returns:
      the RequestedLifetime 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.
    • getRequestedLifetimeNodeAsync

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

      org.eclipse.milo.opcua.stack.core.types.builtin.ByteString getCertificateErrorEventId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the CertificateErrorEventId Node.

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

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

      void setCertificateErrorEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the CertificateErrorEventId Node.

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

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

      org.eclipse.milo.opcua.stack.core.types.builtin.ByteString readCertificateErrorEventId() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the CertificateErrorEventId Node from the server and update the local value if the operation succeeds.
      Returns:
      the ByteString value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • writeCertificateErrorEventId

      void writeCertificateErrorEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the CertificateErrorEventId Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the ByteString value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.
    • readCertificateErrorEventIdAsync

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

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCertificateErrorEventIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.
    • getCertificateErrorEventIdNode

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

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

      Returns:
      the CertificateErrorEventId 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.
    • getCertificateErrorEventIdNodeAsync

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