Module org.eclipse.milo.opcua.sdk.client

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

Class AuditCancelEventTypeNode

java.lang.Object

org.eclipse.milo.opcua.sdk.client.nodes.UaNode

org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode

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

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

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

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

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

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

All Implemented Interfaces:

AuditCancelEventType, AuditEventType, AuditSecurityEventType, AuditSessionEventType, BaseEventType, BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

public class AuditCancelEventTypeNode
extends AuditSessionEventTypeNode
implements AuditCancelEventType

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

client

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.AuditCancelEventType

REQUEST_HANDLE

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.AuditEventType

ACTION_TIME_STAMP, CLIENT_AUDIT_ENTRY_ID, CLIENT_USER_ID, SERVER_ID, STATUS

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.AuditSecurityEventType

STATUS_CODE_ID

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.AuditSessionEventType

SESSION_ID

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.BaseEventType

CONDITION_CLASS_ID, CONDITION_CLASS_NAME, CONDITION_SUB_CLASS_ID, CONDITION_SUB_CLASS_NAME, EVENT_ID, EVENT_TYPE, LOCAL_TIME, MESSAGE, RECEIVE_TIME, SEVERITY, SOURCE_NAME, SOURCE_NODE, TIME

Constructor Summary

Constructors

Constructor

Description

AuditCancelEventTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getRequestHandle()	Get the local value of the RequestHandle Node.
PropertyTypeNode	getRequestHandleNode()	Get the RequestHandle PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getRequestHandleNodeAsync()	Asynchronous implementation of AuditCancelEventType.getRequestHandleNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readRequestHandle()	Read the value of the RequestHandle Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readRequestHandleAsync()	An asynchronous implementation of AuditCancelEventType.readRequestHandle().
void	setRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Set the local value of the RequestHandle Node.
void	writeRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Write a new value for the RequestHandle Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeRequestHandleAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestHandle)	An asynchronous implementation of AuditCancelEventType.writeRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.objects.AuditSessionEventTypeNode

getSessionId, getSessionIdNode, getSessionIdNodeAsync, readSessionId, readSessionIdAsync, setSessionId, writeSessionId, writeSessionIdAsync

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.objects.AuditSecurityEventTypeNode

getStatusCodeId, getStatusCodeIdNode, getStatusCodeIdNodeAsync, readStatusCodeId, readStatusCodeIdAsync, setStatusCodeId, writeStatusCodeId, writeStatusCodeIdAsync

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.objects.AuditEventTypeNode

getActionTimeStamp, getActionTimeStampNode, getActionTimeStampNodeAsync, getClientAuditEntryId, getClientAuditEntryIdNode, getClientAuditEntryIdNodeAsync, getClientUserId, getClientUserIdNode, getClientUserIdNodeAsync, getServerId, getServerIdNode, getServerIdNodeAsync, getStatus, getStatusNode, getStatusNodeAsync, readActionTimeStamp, readActionTimeStampAsync, readClientAuditEntryId, readClientAuditEntryIdAsync, readClientUserId, readClientUserIdAsync, readServerId, readServerIdAsync, readStatus, readStatusAsync, setActionTimeStamp, setClientAuditEntryId, setClientUserId, setServerId, setStatus, writeActionTimeStamp, writeActionTimeStampAsync, writeClientAuditEntryId, writeClientAuditEntryIdAsync, writeClientUserId, writeClientUserIdAsync, writeServerId, writeServerIdAsync, writeStatus, writeStatusAsync

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.objects.BaseEventTypeNode

getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionSubClassId, getConditionSubClassIdNode, getConditionSubClassIdNodeAsync, getConditionSubClassName, getConditionSubClassNameNode, getConditionSubClassNameNodeAsync, getEventId, getEventIdNode, getEventIdNodeAsync, getEventType, getEventTypeNode, getEventTypeNodeAsync, getLocalTime, getLocalTimeNode, getLocalTimeNodeAsync, getMessage, getMessageNode, getMessageNodeAsync, getReceiveTime, getReceiveTimeNode, getReceiveTimeNodeAsync, getSeverity, getSeverityNode, getSeverityNodeAsync, getSourceName, getSourceNameNode, getSourceNameNodeAsync, getSourceNode, getSourceNodeNode, getSourceNodeNodeAsync, getTime, getTimeNode, getTimeNodeAsync, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionSubClassId, readConditionSubClassIdAsync, readConditionSubClassName, readConditionSubClassNameAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setConditionClassId, setConditionClassName, setConditionSubClassId, setConditionSubClassName, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionSubClassId, writeConditionSubClassIdAsync, writeConditionSubClassName, writeConditionSubClassNameAsync, writeEventId, writeEventIdAsync, writeEventType, writeEventTypeAsync, writeLocalTime, writeLocalTimeAsync, writeMessage, writeMessageAsync, writeReceiveTime, writeReceiveTimeAsync, writeSeverity, writeSeverityAsync, writeSourceName, writeSourceNameAsync, writeSourceNode, writeSourceNodeAsync, writeTime, writeTimeAsync

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode

callMethod, callMethod, callMethodAsync, callMethodAsync, getAttributeValue, getEventNotifier, getIconAsync, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersionAsync, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIconAsync, setNamingRuleAsync, setNodeVersionAsync, writeEventNotifier

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, writeUserWriteMask, writeWriteMask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.AuditEventType

getActionTimeStamp, getActionTimeStampNode, getActionTimeStampNodeAsync, getClientAuditEntryId, getClientAuditEntryIdNode, getClientAuditEntryIdNodeAsync, getClientUserId, getClientUserIdNode, getClientUserIdNodeAsync, getServerId, getServerIdNode, getServerIdNodeAsync, getStatus, getStatusNode, getStatusNodeAsync, readActionTimeStamp, readActionTimeStampAsync, readClientAuditEntryId, readClientAuditEntryIdAsync, readClientUserId, readClientUserIdAsync, readServerId, readServerIdAsync, readStatus, readStatusAsync, setActionTimeStamp, setClientAuditEntryId, setClientUserId, setServerId, setStatus, writeActionTimeStamp, writeActionTimeStampAsync, writeClientAuditEntryId, writeClientAuditEntryIdAsync, writeClientUserId, writeClientUserIdAsync, writeServerId, writeServerIdAsync, writeStatus, writeStatusAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.AuditSecurityEventType

getStatusCodeId, getStatusCodeIdNode, getStatusCodeIdNodeAsync, readStatusCodeId, readStatusCodeIdAsync, setStatusCodeId, writeStatusCodeId, writeStatusCodeIdAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.AuditSessionEventType

getSessionId, getSessionIdNode, getSessionIdNodeAsync, readSessionId, readSessionIdAsync, setSessionId, writeSessionId, writeSessionIdAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.BaseEventType

getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionSubClassId, getConditionSubClassIdNode, getConditionSubClassIdNodeAsync, getConditionSubClassName, getConditionSubClassNameNode, getConditionSubClassNameNodeAsync, getEventId, getEventIdNode, getEventIdNodeAsync, getEventType, getEventTypeNode, getEventTypeNodeAsync, getLocalTime, getLocalTimeNode, getLocalTimeNodeAsync, getMessage, getMessageNode, getMessageNodeAsync, getReceiveTime, getReceiveTimeNode, getReceiveTimeNodeAsync, getSeverity, getSeverityNode, getSeverityNodeAsync, getSourceName, getSourceNameNode, getSourceNameNodeAsync, getSourceNode, getSourceNodeNode, getSourceNodeNodeAsync, getTime, getTimeNode, getTimeNodeAsync, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionSubClassId, readConditionSubClassIdAsync, readConditionSubClassName, readConditionSubClassNameAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setConditionClassId, setConditionClassName, setConditionSubClassId, setConditionSubClassName, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionSubClassId, writeConditionSubClassIdAsync, writeConditionSubClassName, writeConditionSubClassNameAsync, writeEventId, writeEventIdAsync, writeEventType, writeEventTypeAsync, writeLocalTime, writeLocalTimeAsync, writeMessage, writeMessageAsync, writeReceiveTime, writeReceiveTimeAsync, writeSeverity, writeSeverityAsync, writeSourceName, writeSourceNameAsync, writeSourceNode, writeSourceNodeAsync, writeTime, writeTimeAsync

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

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

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

getEventNotifier, setEventNotifier

Constructor Details

AuditCancelEventTypeNode

public AuditCancelEventTypeNode(OpcUaClient client,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
 org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass,
 org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Method Details

getRequestHandle

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getRequestHandle()
                                                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AuditCancelEventType

Get the local value of the RequestHandle Node.

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

Specified by:

getRequestHandle in interface AuditCancelEventType

Returns:

the local value of the RequestHandle Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the RequestHandle Node.

setRequestHandle

public void setRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AuditCancelEventType

Set the local value of the RequestHandle Node.

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

Specified by:

setRequestHandle in interface AuditCancelEventType

Parameters:

value - the local value to set for the RequestHandle Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the RequestHandle Node.

readRequestHandle

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readRequestHandle()
                                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AuditCancelEventType

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

Specified by:

readRequestHandle in interface AuditCancelEventType

Returns:

the UInteger value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeRequestHandle

public void writeRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AuditCancelEventType

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

Specified by:

writeRequestHandle in interface AuditCancelEventType

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.

readRequestHandleAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readRequestHandleAsync()

Description copied from interface: AuditCancelEventType

An asynchronous implementation of AuditCancelEventType.readRequestHandle().

Specified by:

readRequestHandleAsync in interface AuditCancelEventType

Returns:

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

writeRequestHandleAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRequestHandleAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger requestHandle)

Description copied from interface: AuditCancelEventType

An asynchronous implementation of AuditCancelEventType.writeRequestHandle(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

Specified by:

writeRequestHandleAsync in interface AuditCancelEventType

Returns:

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

getRequestHandleNode

public PropertyTypeNode getRequestHandleNode()
                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AuditCancelEventType

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

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

Specified by:

getRequestHandleNode in interface AuditCancelEventType

Returns:

the RequestHandle 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.

getRequestHandleNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getRequestHandleNodeAsync()

Description copied from interface: AuditCancelEventType

Asynchronous implementation of AuditCancelEventType.getRequestHandleNode().

Specified by:

getRequestHandleNodeAsync in interface AuditCancelEventType

Returns:

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