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

Interface AuditActivateSessionEventType

All Superinterfaces:

AuditEventType, AuditSecurityEventType, AuditSessionEventType, BaseEventType, BaseObjectType, Node, ObjectNode

All Known Implementing Classes:

AuditActivateSessionEventTypeNode

public interface AuditActivateSessionEventType
extends AuditSessionEventType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[]>	CLIENT_SOFTWARE_CERTIFICATES
static QualifiedProperty<String>	SECURE_CHANNEL_ID
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken>	USER_IDENTITY_TOKEN

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

SESSION_ID

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.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.types.objects.BaseEventType

EVENT_ID, EVENT_TYPE, LOCAL_TIME, MESSAGE, RECEIVE_TIME, SEVERITY, SOURCE_NAME, SOURCE_NODE, TIME

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[]	getClientSoftwareCertificates() Get the local value of the ClientSoftwareCertificates Node.
PropertyType	getClientSoftwareCertificatesNode() Get the ClientSoftwareCertificates PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getClientSoftwareCertificatesNodeAsync() Asynchronous implementation of getClientSoftwareCertificatesNode().
String	getSecureChannelId() Get the local value of the SecureChannelId Node.
PropertyType	getSecureChannelIdNode() Get the SecureChannelId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getSecureChannelIdNodeAsync() Asynchronous implementation of getSecureChannelIdNode().
org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken	getUserIdentityToken() Get the local value of the UserIdentityToken Node.
PropertyType	getUserIdentityTokenNode() Get the UserIdentityToken PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getUserIdentityTokenNodeAsync() Asynchronous implementation of getUserIdentityTokenNode().
org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[]	readClientSoftwareCertificates() Read the value of the ClientSoftwareCertificates Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[]>	readClientSoftwareCertificatesAsync() An asynchronous implementation of readClientSoftwareCertificates().
String	readSecureChannelId() Read the value of the SecureChannelId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readSecureChannelIdAsync() An asynchronous implementation of readSecureChannelId().
org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken	readUserIdentityToken() Read the value of the UserIdentityToken Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken>	readUserIdentityTokenAsync() An asynchronous implementation of readUserIdentityToken().
void	setClientSoftwareCertificates(org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[] clientSoftwareCertificates) Set the local value of the ClientSoftwareCertificates Node.
void	setSecureChannelId(String secureChannelId) Set the local value of the SecureChannelId Node.
void	setUserIdentityToken(org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken userIdentityToken) Set the local value of the UserIdentityToken Node.
void	writeClientSoftwareCertificates(org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[] clientSoftwareCertificates) Write a new value for the ClientSoftwareCertificates Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeClientSoftwareCertificatesAsync(org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[] clientSoftwareCertificates) An asynchronous implementation of writeClientSoftwareCertificates(SignedSoftwareCertificate[]).
void	writeSecureChannelId(String secureChannelId) Write a new value for the SecureChannelId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSecureChannelIdAsync(String secureChannelId) An asynchronous implementation of writeSecureChannelId(String).
void	writeUserIdentityToken(org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken userIdentityToken) Write a new value for the UserIdentityToken Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeUserIdentityTokenAsync(org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken userIdentityToken) An asynchronous implementation of writeUserIdentityToken(UserIdentityToken).

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

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

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.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.types.objects.BaseEventType

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, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, 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.ObjectNode

getEventNotifier, setEventNotifier

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

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Field Detail

CLIENT_SOFTWARE_CERTIFICATES

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[]> CLIENT_SOFTWARE_CERTIFICATES

USER_IDENTITY_TOKEN

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken> USER_IDENTITY_TOKEN

SECURE_CHANNEL_ID

static final QualifiedProperty<String> SECURE_CHANNEL_ID

Method Detail

getClientSoftwareCertificates

org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[] getClientSoftwareCertificates()
                                                                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ClientSoftwareCertificates Node.

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

Returns:

the local value of the ClientSoftwareCertificates Node.

Throws:

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

setClientSoftwareCertificates

void setClientSoftwareCertificates(org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[] clientSoftwareCertificates)
                            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ClientSoftwareCertificates Node.

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

Parameters:

clientSoftwareCertificates - the local value to set for the ClientSoftwareCertificates Node.

Throws:

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

readClientSoftwareCertificates

org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[] readClientSoftwareCertificates()
                                                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the SignedSoftwareCertificate[] value read from the server.

Throws:

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

writeClientSoftwareCertificates

void writeClientSoftwareCertificates(org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[] clientSoftwareCertificates)
                              throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

clientSoftwareCertificates - the SignedSoftwareCertificate[] value to write to the server.

Throws:

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

readClientSoftwareCertificatesAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[]> readClientSoftwareCertificatesAsync()

An asynchronous implementation of readClientSoftwareCertificates().

Returns:

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

writeClientSoftwareCertificatesAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeClientSoftwareCertificatesAsync(org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[] clientSoftwareCertificates)

An asynchronous implementation of writeClientSoftwareCertificates(SignedSoftwareCertificate[]).

Returns:

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

getClientSoftwareCertificatesNode

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

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

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

Returns:

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

getClientSoftwareCertificatesNodeAsync

CompletableFuture<? extends PropertyType> getClientSoftwareCertificatesNodeAsync()

Asynchronous implementation of getClientSoftwareCertificatesNode().

Returns:

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

getUserIdentityToken

org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken getUserIdentityToken()
                                                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the UserIdentityToken Node.

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

Returns:

the local value of the UserIdentityToken Node.

Throws:

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

setUserIdentityToken

void setUserIdentityToken(org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken userIdentityToken)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the UserIdentityToken Node.

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

Parameters:

userIdentityToken - the local value to set for the UserIdentityToken Node.

Throws:

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

readUserIdentityToken

org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken readUserIdentityToken()
                                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the UserIdentityToken value read from the server.

Throws:

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

writeUserIdentityToken

void writeUserIdentityToken(org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken userIdentityToken)
                     throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

userIdentityToken - the UserIdentityToken value to write to the server.

Throws:

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

readUserIdentityTokenAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken> readUserIdentityTokenAsync()

An asynchronous implementation of readUserIdentityToken().

Returns:

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

writeUserIdentityTokenAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeUserIdentityTokenAsync(org.eclipse.milo.opcua.stack.core.types.structured.UserIdentityToken userIdentityToken)

An asynchronous implementation of writeUserIdentityToken(UserIdentityToken).

Returns:

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

getUserIdentityTokenNode

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

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

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

Returns:

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

getUserIdentityTokenNodeAsync

CompletableFuture<? extends PropertyType> getUserIdentityTokenNodeAsync()

Asynchronous implementation of getUserIdentityTokenNode().

Returns:

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

getSecureChannelId

String getSecureChannelId()
                   throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SecureChannelId Node.

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

Returns:

the local value of the SecureChannelId Node.

Throws:

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

setSecureChannelId

void setSecureChannelId(String secureChannelId)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SecureChannelId Node.

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

Parameters:

secureChannelId - the local value to set for the SecureChannelId Node.

Throws:

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

readSecureChannelId

String readSecureChannelId()
                    throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the SecureChannelId 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.

writeSecureChannelId

void writeSecureChannelId(String secureChannelId)
                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

secureChannelId - the String value to write to the server.

Throws:

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

readSecureChannelIdAsync

CompletableFuture<? extends String> readSecureChannelIdAsync()

An asynchronous implementation of readSecureChannelId().

Returns:

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

writeSecureChannelIdAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSecureChannelIdAsync(String secureChannelId)

An asynchronous implementation of writeSecureChannelId(String).

Returns:

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

getSecureChannelIdNode

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

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

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

Returns:

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

getSecureChannelIdNodeAsync

CompletableFuture<? extends PropertyType> getSecureChannelIdNodeAsync()

Asynchronous implementation of getSecureChannelIdNode().

Returns:

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