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

Interface AuditEventType

All Superinterfaces:
BaseEventType, BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Subinterfaces:
AuditActivateSessionEventType, AuditAddNodesEventType, AuditAddReferencesEventType, AuditCancelEventType, AuditCertificateDataMismatchEventType, AuditCertificateEventType, AuditCertificateExpiredEventType, AuditCertificateInvalidEventType, AuditCertificateMismatchEventType, AuditCertificateRevokedEventType, AuditCertificateUntrustedEventType, AuditChannelEventType, AuditClientEventType, AuditClientUpdateMethodResultEventType, AuditConditionAcknowledgeEventType, AuditConditionCommentEventType, AuditConditionConfirmEventType, AuditConditionEnableEventType, AuditConditionEventType, AuditConditionOutOfServiceEventType, AuditConditionResetEventType, AuditConditionRespondEventType, AuditConditionShelvingEventType, AuditConditionSilenceEventType, AuditConditionSuppressionEventType, AuditCreateSessionEventType, AuditDeleteNodesEventType, AuditDeleteReferencesEventType, AuditHistoryAnnotationUpdateEventType, AuditHistoryAtTimeDeleteEventType, AuditHistoryBulkInsertEventType, AuditHistoryConfigurationChangeEventType, AuditHistoryDeleteEventType, AuditHistoryEventDeleteEventType, AuditHistoryEventUpdateEventType, AuditHistoryRawModifyDeleteEventType, AuditHistoryUpdateEventType, AuditHistoryValueUpdateEventType, AuditNodeManagementEventType, AuditOpenSecureChannelEventType, AuditProgramTransitionEventType, AuditSecurityEventType, AuditSessionEventType, AuditUpdateEventType, AuditUpdateMethodEventType, AuditUpdateStateEventType, AuditUrlMismatchEventType, AuditWriteUpdateEventType, CertificateUpdatedAuditEventType, CertificateUpdateRequestedAuditEventType, KeyCredentialAuditEventType, KeyCredentialDeletedAuditEventType, KeyCredentialUpdatedAuditEventType, ProgramTransitionAuditEventType, RoleMappingRuleChangedAuditEventType, TrustListUpdatedAuditEventType, TrustListUpdateRequestedAuditEventType
All Known Implementing Classes:
AuditActivateSessionEventTypeNode, AuditAddNodesEventTypeNode, AuditAddReferencesEventTypeNode, AuditCancelEventTypeNode, AuditCertificateDataMismatchEventTypeNode, AuditCertificateEventTypeNode, AuditCertificateExpiredEventTypeNode, AuditCertificateInvalidEventTypeNode, AuditCertificateMismatchEventTypeNode, AuditCertificateRevokedEventTypeNode, AuditCertificateUntrustedEventTypeNode, AuditChannelEventTypeNode, AuditClientEventTypeNode, AuditClientUpdateMethodResultEventTypeNode, AuditConditionAcknowledgeEventTypeNode, AuditConditionCommentEventTypeNode, AuditConditionConfirmEventTypeNode, AuditConditionEnableEventTypeNode, AuditConditionEventTypeNode, AuditConditionOutOfServiceEventTypeNode, AuditConditionResetEventTypeNode, AuditConditionRespondEventTypeNode, AuditConditionShelvingEventTypeNode, AuditConditionSilenceEventTypeNode, AuditConditionSuppressionEventTypeNode, AuditCreateSessionEventTypeNode, AuditDeleteNodesEventTypeNode, AuditDeleteReferencesEventTypeNode, AuditEventTypeNode, AuditHistoryAnnotationUpdateEventTypeNode, AuditHistoryAtTimeDeleteEventTypeNode, AuditHistoryBulkInsertEventTypeNode, AuditHistoryConfigurationChangeEventTypeNode, AuditHistoryDeleteEventTypeNode, AuditHistoryEventDeleteEventTypeNode, AuditHistoryEventUpdateEventTypeNode, AuditHistoryRawModifyDeleteEventTypeNode, AuditHistoryUpdateEventTypeNode, AuditHistoryValueUpdateEventTypeNode, AuditNodeManagementEventTypeNode, AuditOpenSecureChannelEventTypeNode, AuditProgramTransitionEventTypeNode, AuditSecurityEventTypeNode, AuditSessionEventTypeNode, AuditUpdateEventTypeNode, AuditUpdateMethodEventTypeNode, AuditUpdateStateEventTypeNode, AuditUrlMismatchEventTypeNode, AuditWriteUpdateEventTypeNode, CertificateUpdatedAuditEventTypeNode, CertificateUpdateRequestedAuditEventTypeNode, KeyCredentialAuditEventTypeNode, KeyCredentialDeletedAuditEventTypeNode, KeyCredentialUpdatedAuditEventTypeNode, ProgramTransitionAuditEventTypeNode, RoleMappingRuleChangedAuditEventTypeNode, TrustListUpdatedAuditEventTypeNode, TrustListUpdateRequestedAuditEventTypeNode
public interface AuditEventType extends BaseEventType
See Also:

  • Field Details

    • ACTION_TIME_STAMP

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

    • STATUS

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

    • SERVER_ID

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

    • CLIENT_AUDIT_ENTRY_ID

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

    • CLIENT_USER_ID

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

  • Method Details

    • getActionTimeStamp

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

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

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

    • setActionTimeStamp

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

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

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

    • readActionTimeStamp

      org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readActionTimeStamp() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the ActionTimeStamp 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.

    • writeActionTimeStamp

      void writeActionTimeStamp(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ActionTimeStamp 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.

    • readActionTimeStampAsync

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

    • writeActionTimeStampAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeActionTimeStampAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime value)
      An asynchronous implementation of writeActionTimeStamp(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.

    • getActionTimeStampNode

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

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

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

    • getActionTimeStampNodeAsync

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

    • getStatus

      Boolean getStatus() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Status Node.

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

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

    • setStatus

      void setStatus(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Status Node.

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

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

    • readStatus

      Boolean readStatus() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the Status 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.

    • writeStatus

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

    • readStatusAsync

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

    • writeStatusAsync

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

    • getStatusNode

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

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

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

    • getStatusNodeAsync

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

    • getServerId

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

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

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

    • setServerId

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

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

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

    • readServerId

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

    • writeServerId

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

    • readServerIdAsync

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

    • writeServerIdAsync

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

    • getServerIdNode

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

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

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

    • getServerIdNodeAsync

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

    • getClientAuditEntryId

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

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

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

    • setClientAuditEntryId

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

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

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

    • readClientAuditEntryId

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

    • writeClientAuditEntryId

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

    • readClientAuditEntryIdAsync

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

    • writeClientAuditEntryIdAsync

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

    • getClientAuditEntryIdNode

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

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

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

    • getClientAuditEntryIdNodeAsync

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

    • getClientUserId

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

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

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

    • setClientUserId

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

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

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

    • readClientUserId

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

    • writeClientUserId

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

    • readClientUserIdAsync

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

    • writeClientUserIdAsync

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

    • getClientUserIdNode

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

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

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

    • getClientUserIdNodeAsync

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