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

Interface ServerConfigurationType

All Superinterfaces:

BaseObjectType, Node, ObjectNode

All Known Implementing Classes:

ServerConfigurationTypeNode

public interface ServerConfigurationType
extends BaseObjectType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	MAX_TRUST_LIST_SIZE
static QualifiedProperty<Boolean>	MULTICAST_DNS_ENABLED
static QualifiedProperty<String[]>	SERVER_CAPABILITIES
static QualifiedProperty<String[]>	SUPPORTED_PRIVATE_KEY_FORMATS

Method Summary

Modifier and Type	Method and Description
CertificateGroupFolderType	getCertificateGroupsNode() Get the CertificateGroups CertificateGroupFolderType Node, or null if it does not exist.
CompletableFuture<? extends CertificateGroupFolderType>	getCertificateGroupsNodeAsync() Asynchronous implementation of getCertificateGroupsNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getMaxTrustListSize() Get the local value of the MaxTrustListSize Node.
PropertyType	getMaxTrustListSizeNode() Get the MaxTrustListSize PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getMaxTrustListSizeNodeAsync() Asynchronous implementation of getMaxTrustListSizeNode().
Boolean	getMulticastDnsEnabled() Get the local value of the MulticastDnsEnabled Node.
PropertyType	getMulticastDnsEnabledNode() Get the MulticastDnsEnabled PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getMulticastDnsEnabledNodeAsync() Asynchronous implementation of getMulticastDnsEnabledNode().
String[]	getServerCapabilities() Get the local value of the ServerCapabilities Node.
PropertyType	getServerCapabilitiesNode() Get the ServerCapabilities PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getServerCapabilitiesNodeAsync() Asynchronous implementation of getServerCapabilitiesNode().
String[]	getSupportedPrivateKeyFormats() Get the local value of the SupportedPrivateKeyFormats Node.
PropertyType	getSupportedPrivateKeyFormatsNode() Get the SupportedPrivateKeyFormats PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getSupportedPrivateKeyFormatsNodeAsync() Asynchronous implementation of getSupportedPrivateKeyFormatsNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readMaxTrustListSize() Read the value of the MaxTrustListSize 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>	readMaxTrustListSizeAsync() An asynchronous implementation of readMaxTrustListSize().
Boolean	readMulticastDnsEnabled() Read the value of the MulticastDnsEnabled Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readMulticastDnsEnabledAsync() An asynchronous implementation of readMulticastDnsEnabled().
String[]	readServerCapabilities() Read the value of the ServerCapabilities Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String[]>	readServerCapabilitiesAsync() An asynchronous implementation of readServerCapabilities().
String[]	readSupportedPrivateKeyFormats() Read the value of the SupportedPrivateKeyFormats Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String[]>	readSupportedPrivateKeyFormatsAsync() An asynchronous implementation of readSupportedPrivateKeyFormats().
void	setMaxTrustListSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxTrustListSize) Set the local value of the MaxTrustListSize Node.
void	setMulticastDnsEnabled(Boolean multicastDnsEnabled) Set the local value of the MulticastDnsEnabled Node.
void	setServerCapabilities(String[] serverCapabilities) Set the local value of the ServerCapabilities Node.
void	setSupportedPrivateKeyFormats(String[] supportedPrivateKeyFormats) Set the local value of the SupportedPrivateKeyFormats Node.
void	writeMaxTrustListSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxTrustListSize) Write a new value for the MaxTrustListSize Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMaxTrustListSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxTrustListSize) An asynchronous implementation of writeMaxTrustListSize(UInteger).
void	writeMulticastDnsEnabled(Boolean multicastDnsEnabled) Write a new value for the MulticastDnsEnabled Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMulticastDnsEnabledAsync(Boolean multicastDnsEnabled) An asynchronous implementation of writeMulticastDnsEnabled(Boolean).
void	writeServerCapabilities(String[] serverCapabilities) Write a new value for the ServerCapabilities Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeServerCapabilitiesAsync(String[] serverCapabilities) An asynchronous implementation of writeServerCapabilities(String[]).
void	writeSupportedPrivateKeyFormats(String[] supportedPrivateKeyFormats) Write a new value for the SupportedPrivateKeyFormats Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSupportedPrivateKeyFormatsAsync(String[] supportedPrivateKeyFormats) An asynchronous implementation of writeSupportedPrivateKeyFormats(String[]).

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

SERVER_CAPABILITIES

static final QualifiedProperty<String[]> SERVER_CAPABILITIES

SUPPORTED_PRIVATE_KEY_FORMATS

static final QualifiedProperty<String[]> SUPPORTED_PRIVATE_KEY_FORMATS

MAX_TRUST_LIST_SIZE

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> MAX_TRUST_LIST_SIZE

MULTICAST_DNS_ENABLED

static final QualifiedProperty<Boolean> MULTICAST_DNS_ENABLED

Method Detail

getServerCapabilities

String[] getServerCapabilities()
                        throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ServerCapabilities Node.

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

Returns:

the local value of the ServerCapabilities Node.

Throws:

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

setServerCapabilities

void setServerCapabilities(String[] serverCapabilities)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ServerCapabilities Node.

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

Parameters:

serverCapabilities - the local value to set for the ServerCapabilities Node.

Throws:

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

readServerCapabilities

String[] readServerCapabilities()
                         throws org.eclipse.milo.opcua.stack.core.UaException

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

writeServerCapabilities

void writeServerCapabilities(String[] serverCapabilities)
                      throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

serverCapabilities - the String[] value to write to the server.

Throws:

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

readServerCapabilitiesAsync

CompletableFuture<? extends String[]> readServerCapabilitiesAsync()

An asynchronous implementation of readServerCapabilities().

Returns:

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

writeServerCapabilitiesAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeServerCapabilitiesAsync(String[] serverCapabilities)

An asynchronous implementation of writeServerCapabilities(String[]).

Returns:

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

getServerCapabilitiesNode

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

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

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

Returns:

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

getServerCapabilitiesNodeAsync

CompletableFuture<? extends PropertyType> getServerCapabilitiesNodeAsync()

Asynchronous implementation of getServerCapabilitiesNode().

Returns:

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

getSupportedPrivateKeyFormats

String[] getSupportedPrivateKeyFormats()
                                throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SupportedPrivateKeyFormats Node.

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

Returns:

the local value of the SupportedPrivateKeyFormats Node.

Throws:

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

setSupportedPrivateKeyFormats

void setSupportedPrivateKeyFormats(String[] supportedPrivateKeyFormats)
                            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SupportedPrivateKeyFormats Node.

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

Parameters:

supportedPrivateKeyFormats - the local value to set for the SupportedPrivateKeyFormats Node.

Throws:

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

readSupportedPrivateKeyFormats

String[] readSupportedPrivateKeyFormats()
                                 throws org.eclipse.milo.opcua.stack.core.UaException

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

writeSupportedPrivateKeyFormats

void writeSupportedPrivateKeyFormats(String[] supportedPrivateKeyFormats)
                              throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

supportedPrivateKeyFormats - the String[] value to write to the server.

Throws:

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

readSupportedPrivateKeyFormatsAsync

CompletableFuture<? extends String[]> readSupportedPrivateKeyFormatsAsync()

An asynchronous implementation of readSupportedPrivateKeyFormats().

Returns:

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

writeSupportedPrivateKeyFormatsAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSupportedPrivateKeyFormatsAsync(String[] supportedPrivateKeyFormats)

An asynchronous implementation of writeSupportedPrivateKeyFormats(String[]).

Returns:

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

getSupportedPrivateKeyFormatsNode

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

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

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

Returns:

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

getSupportedPrivateKeyFormatsNodeAsync

CompletableFuture<? extends PropertyType> getSupportedPrivateKeyFormatsNodeAsync()

Asynchronous implementation of getSupportedPrivateKeyFormatsNode().

Returns:

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

getMaxTrustListSize

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

Get the local value of the MaxTrustListSize Node.

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

Returns:

the local value of the MaxTrustListSize Node.

Throws:

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

setMaxTrustListSize

void setMaxTrustListSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxTrustListSize)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the MaxTrustListSize Node.

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

Parameters:

maxTrustListSize - the local value to set for the MaxTrustListSize Node.

Throws:

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

readMaxTrustListSize

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

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

Returns:

the UInteger value read from the server.

Throws:

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

writeMaxTrustListSize

void writeMaxTrustListSize(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxTrustListSize)
                    throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

maxTrustListSize - the UInteger value to write to the server.

Throws:

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

readMaxTrustListSizeAsync

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

An asynchronous implementation of readMaxTrustListSize().

Returns:

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

writeMaxTrustListSizeAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMaxTrustListSizeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger maxTrustListSize)

An asynchronous implementation of writeMaxTrustListSize(UInteger).

Returns:

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

getMaxTrustListSizeNode

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

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

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

Returns:

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

getMaxTrustListSizeNodeAsync

CompletableFuture<? extends PropertyType> getMaxTrustListSizeNodeAsync()

Asynchronous implementation of getMaxTrustListSizeNode().

Returns:

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

getMulticastDnsEnabled

Boolean getMulticastDnsEnabled()
                        throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the MulticastDnsEnabled Node.

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

Returns:

the local value of the MulticastDnsEnabled Node.

Throws:

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

setMulticastDnsEnabled

void setMulticastDnsEnabled(Boolean multicastDnsEnabled)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the MulticastDnsEnabled Node.

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

Parameters:

multicastDnsEnabled - the local value to set for the MulticastDnsEnabled Node.

Throws:

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

readMulticastDnsEnabled

Boolean readMulticastDnsEnabled()
                         throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Boolean value read from the server.

Throws:

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

writeMulticastDnsEnabled

void writeMulticastDnsEnabled(Boolean multicastDnsEnabled)
                       throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

multicastDnsEnabled - the Boolean value to write to the server.

Throws:

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

readMulticastDnsEnabledAsync

CompletableFuture<? extends Boolean> readMulticastDnsEnabledAsync()

An asynchronous implementation of readMulticastDnsEnabled().

Returns:

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

writeMulticastDnsEnabledAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeMulticastDnsEnabledAsync(Boolean multicastDnsEnabled)

An asynchronous implementation of writeMulticastDnsEnabled(Boolean).

Returns:

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

getMulticastDnsEnabledNode

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

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

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

Returns:

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

getMulticastDnsEnabledNodeAsync

CompletableFuture<? extends PropertyType> getMulticastDnsEnabledNodeAsync()

Asynchronous implementation of getMulticastDnsEnabledNode().

Returns:

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

getCertificateGroupsNode

CertificateGroupFolderType getCertificateGroupsNode()
                                             throws org.eclipse.milo.opcua.stack.core.UaException

Get the CertificateGroups CertificateGroupFolderType Node, or null if it does not exist.

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

Returns:

the CertificateGroups CertificateGroupFolderType 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.

getCertificateGroupsNodeAsync

CompletableFuture<? extends CertificateGroupFolderType> getCertificateGroupsNodeAsync()

Asynchronous implementation of getCertificateGroupsNode().

Returns:

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