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

Interface AuditCreateSessionEventType

All Superinterfaces:

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

All Known Subinterfaces:

AuditUrlMismatchEventType

All Known Implementing Classes:

AuditCreateSessionEventTypeNode, AuditUrlMismatchEventTypeNode

public interface AuditCreateSessionEventType
extends AuditSessionEventType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>	CLIENT_CERTIFICATE
static QualifiedProperty<String>	CLIENT_CERTIFICATE_THUMBPRINT
static QualifiedProperty<Double>	REVISED_SESSION_TIMEOUT
static QualifiedProperty<String>	SECURE_CHANNEL_ID

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.builtin.ByteString	getClientCertificate() Get the local value of the ClientCertificate Node.
PropertyType	getClientCertificateNode() Get the ClientCertificate PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getClientCertificateNodeAsync() Asynchronous implementation of getClientCertificateNode().
String	getClientCertificateThumbprint() Get the local value of the ClientCertificateThumbprint Node.
PropertyType	getClientCertificateThumbprintNode() Get the ClientCertificateThumbprint PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getClientCertificateThumbprintNodeAsync() Asynchronous implementation of getClientCertificateThumbprintNode().
Double	getRevisedSessionTimeout() Get the local value of the RevisedSessionTimeout Node.
PropertyType	getRevisedSessionTimeoutNode() Get the RevisedSessionTimeout PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getRevisedSessionTimeoutNodeAsync() Asynchronous implementation of getRevisedSessionTimeoutNode().
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.builtin.ByteString	readClientCertificate() Read the value of the ClientCertificate Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>	readClientCertificateAsync() An asynchronous implementation of readClientCertificate().
String	readClientCertificateThumbprint() Read the value of the ClientCertificateThumbprint Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readClientCertificateThumbprintAsync() An asynchronous implementation of readClientCertificateThumbprint().
Double	readRevisedSessionTimeout() Read the value of the RevisedSessionTimeout Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readRevisedSessionTimeoutAsync() An asynchronous implementation of readRevisedSessionTimeout().
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().
void	setClientCertificate(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate) Set the local value of the ClientCertificate Node.
void	setClientCertificateThumbprint(String clientCertificateThumbprint) Set the local value of the ClientCertificateThumbprint Node.
void	setRevisedSessionTimeout(Double revisedSessionTimeout) Set the local value of the RevisedSessionTimeout Node.
void	setSecureChannelId(String secureChannelId) Set the local value of the SecureChannelId Node.
void	writeClientCertificate(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate) Write a new value for the ClientCertificate Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeClientCertificateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate) An asynchronous implementation of writeClientCertificate(ByteString).
void	writeClientCertificateThumbprint(String clientCertificateThumbprint) Write a new value for the ClientCertificateThumbprint Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeClientCertificateThumbprintAsync(String clientCertificateThumbprint) An asynchronous implementation of writeClientCertificateThumbprint(String).
void	writeRevisedSessionTimeout(Double revisedSessionTimeout) Write a new value for the RevisedSessionTimeout Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeRevisedSessionTimeoutAsync(Double revisedSessionTimeout) An asynchronous implementation of writeRevisedSessionTimeout(Double).
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).

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

SECURE_CHANNEL_ID

static final QualifiedProperty<String> SECURE_CHANNEL_ID

CLIENT_CERTIFICATE

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> CLIENT_CERTIFICATE

CLIENT_CERTIFICATE_THUMBPRINT

static final QualifiedProperty<String> CLIENT_CERTIFICATE_THUMBPRINT

REVISED_SESSION_TIMEOUT

static final QualifiedProperty<Double> REVISED_SESSION_TIMEOUT

Method Detail

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.

getClientCertificate

org.eclipse.milo.opcua.stack.core.types.builtin.ByteString getClientCertificate()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ClientCertificate Node.

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

Returns:

the local value of the ClientCertificate Node.

Throws:

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

setClientCertificate

void setClientCertificate(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ClientCertificate Node.

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

Parameters:

clientCertificate - the local value to set for the ClientCertificate Node.

Throws:

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

readClientCertificate

org.eclipse.milo.opcua.stack.core.types.builtin.ByteString readClientCertificate()
                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the ByteString value read from the server.

Throws:

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

writeClientCertificate

void writeClientCertificate(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate)
                     throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

clientCertificate - the ByteString value to write to the server.

Throws:

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

readClientCertificateAsync

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

An asynchronous implementation of readClientCertificate().

Returns:

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

writeClientCertificateAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeClientCertificateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString clientCertificate)

An asynchronous implementation of writeClientCertificate(ByteString).

Returns:

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

getClientCertificateNode

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

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

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

Returns:

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

getClientCertificateNodeAsync

CompletableFuture<? extends PropertyType> getClientCertificateNodeAsync()

Asynchronous implementation of getClientCertificateNode().

Returns:

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

getClientCertificateThumbprint

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

Get the local value of the ClientCertificateThumbprint Node.

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

Returns:

the local value of the ClientCertificateThumbprint Node.

Throws:

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

setClientCertificateThumbprint

void setClientCertificateThumbprint(String clientCertificateThumbprint)
                             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ClientCertificateThumbprint Node.

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

Parameters:

clientCertificateThumbprint - the local value to set for the ClientCertificateThumbprint Node.

Throws:

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

readClientCertificateThumbprint

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

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

writeClientCertificateThumbprint

void writeClientCertificateThumbprint(String clientCertificateThumbprint)
                               throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

clientCertificateThumbprint - the String value to write to the server.

Throws:

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

readClientCertificateThumbprintAsync

CompletableFuture<? extends String> readClientCertificateThumbprintAsync()

An asynchronous implementation of readClientCertificateThumbprint().

Returns:

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

writeClientCertificateThumbprintAsync

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

An asynchronous implementation of writeClientCertificateThumbprint(String).

Returns:

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

getClientCertificateThumbprintNode

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

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

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

Returns:

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

getClientCertificateThumbprintNodeAsync

CompletableFuture<? extends PropertyType> getClientCertificateThumbprintNodeAsync()

Asynchronous implementation of getClientCertificateThumbprintNode().

Returns:

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

getRevisedSessionTimeout

Double getRevisedSessionTimeout()
                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the RevisedSessionTimeout Node.

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

Returns:

the local value of the RevisedSessionTimeout Node.

Throws:

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

setRevisedSessionTimeout

void setRevisedSessionTimeout(Double revisedSessionTimeout)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the RevisedSessionTimeout Node.

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

Parameters:

revisedSessionTimeout - the local value to set for the RevisedSessionTimeout Node.

Throws:

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

readRevisedSessionTimeout

Double readRevisedSessionTimeout()
                          throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Double value read from the server.

Throws:

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

writeRevisedSessionTimeout

void writeRevisedSessionTimeout(Double revisedSessionTimeout)
                         throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

revisedSessionTimeout - the Double value to write to the server.

Throws:

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

readRevisedSessionTimeoutAsync

CompletableFuture<? extends Double> readRevisedSessionTimeoutAsync()

An asynchronous implementation of readRevisedSessionTimeout().

Returns:

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

writeRevisedSessionTimeoutAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRevisedSessionTimeoutAsync(Double revisedSessionTimeout)

An asynchronous implementation of writeRevisedSessionTimeout(Double).

Returns:

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

getRevisedSessionTimeoutNode

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

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

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

Returns:

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

getRevisedSessionTimeoutNodeAsync

CompletableFuture<? extends PropertyType> getRevisedSessionTimeoutNodeAsync()

Asynchronous implementation of getRevisedSessionTimeoutNode().

Returns:

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