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

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

Interface AuditSecurityEventType

All Superinterfaces:

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

All Known Subinterfaces:

AuditActivateSessionEventType, AuditCancelEventType, AuditCertificateDataMismatchEventType, AuditCertificateEventType, AuditCertificateExpiredEventType, AuditCertificateInvalidEventType, AuditCertificateMismatchEventType, AuditCertificateRevokedEventType, AuditCertificateUntrustedEventType, AuditChannelEventType, AuditCreateSessionEventType, AuditOpenSecureChannelEventType, AuditSessionEventType, AuditUrlMismatchEventType

All Known Implementing Classes:

AuditActivateSessionEventTypeNode, AuditCancelEventTypeNode, AuditCertificateDataMismatchEventTypeNode, AuditCertificateEventTypeNode, AuditCertificateExpiredEventTypeNode, AuditCertificateInvalidEventTypeNode, AuditCertificateMismatchEventTypeNode, AuditCertificateRevokedEventTypeNode, AuditCertificateUntrustedEventTypeNode, AuditChannelEventTypeNode, AuditCreateSessionEventTypeNode, AuditOpenSecureChannelEventTypeNode, AuditSecurityEventTypeNode, AuditSessionEventTypeNode, AuditUrlMismatchEventTypeNode

public interface AuditSecurityEventType
extends AuditEventType

See Also:

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

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.StatusCode>	STATUS_CODE_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.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.StatusCode	getStatusCodeId()	Get the local value of the StatusCodeId Node.
PropertyType	getStatusCodeIdNode()	Get the StatusCodeId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getStatusCodeIdNodeAsync()	Asynchronous implementation of getStatusCodeIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode	readStatusCodeId()	Read the value of the StatusCodeId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	readStatusCodeIdAsync()	An asynchronous implementation of readStatusCodeId().
void	setStatusCodeId(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode value)	Set the local value of the StatusCodeId Node.
void	writeStatusCodeId(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode value)	Write a new value for the StatusCodeId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeStatusCodeIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode value)	An asynchronous implementation of writeStatusCodeId(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode).

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

STATUS_CODE_ID

static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> STATUS_CODE_ID

Method Details

getStatusCodeId

org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode getStatusCodeId()
                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the StatusCodeId Node.

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

Returns:

the local value of the StatusCodeId Node.

Throws:

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

setStatusCodeId

void setStatusCodeId(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode value)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the StatusCodeId Node.

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

Parameters:

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

Throws:

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

readStatusCodeId

org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode readStatusCodeId()
                                                                     throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the StatusCode value read from the server.

Throws:

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

writeStatusCodeId

void writeStatusCodeId(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode value)
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

value - the StatusCode value to write to the server.

Throws:

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

readStatusCodeIdAsync

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

An asynchronous implementation of readStatusCodeId().

Returns:

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

writeStatusCodeIdAsync

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

An asynchronous implementation of writeStatusCodeId(org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode).

Returns:

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

getStatusCodeIdNode

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

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

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

Returns:

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

getStatusCodeIdNodeAsync

CompletableFuture<? extends PropertyType> getStatusCodeIdNodeAsync()

Asynchronous implementation of getStatusCodeIdNode().

Returns:

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