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

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

Interface AuditSessionEventType

All Superinterfaces:

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

All Known Subinterfaces:

AuditActivateSessionEventType, AuditCancelEventType, AuditCreateSessionEventType, AuditUrlMismatchEventType

All Known Implementing Classes:

AuditActivateSessionEventTypeNode, AuditCancelEventTypeNode, AuditCreateSessionEventTypeNode, AuditSessionEventTypeNode, AuditUrlMismatchEventTypeNode

public interface AuditSessionEventType
extends AuditSecurityEventType

See Also:

• https://reference.opcfoundation.org/v105/Core/docs/Part5/6.4.7

Field Summary

Fields

Modifier and Type	Field	Description
static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	SESSION_ID

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

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getSessionId()	Get the local value of the SessionId Node.
PropertyType	getSessionIdNode()	Get the SessionId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getSessionIdNodeAsync()	Asynchronous implementation of getSessionIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readSessionId()	Read the value of the SessionId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readSessionIdAsync()	An asynchronous implementation of readSessionId().
void	setSessionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)	Set the local value of the SessionId Node.
void	writeSessionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)	Write a new value for the SessionId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSessionIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)	An asynchronous implementation of writeSessionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).

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

Field Details

SESSION_ID

static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> SESSION_ID

Method Details

getSessionId

org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getSessionId()
                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SessionId Node.

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

Returns:

the local value of the SessionId Node.

Throws:

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

setSessionId

void setSessionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SessionId Node.

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

Parameters:

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

Throws:

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

readSessionId

org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readSessionId()
                                                              throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the NodeId value read from the server.

Throws:

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

writeSessionId

void writeSessionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)
             throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

value - the NodeId value to write to the server.

Throws:

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

readSessionIdAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> readSessionIdAsync()

An asynchronous implementation of readSessionId().

Returns:

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

writeSessionIdAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSessionIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId value)

An asynchronous implementation of writeSessionId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId).

Returns:

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

getSessionIdNode

PropertyType getSessionIdNode()
                       throws org.eclipse.milo.opcua.stack.core.UaException

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

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

Returns:

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

getSessionIdNodeAsync

CompletableFuture<? extends PropertyType> getSessionIdNodeAsync()

Asynchronous implementation of getSessionIdNode().

Returns:

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