org.eclipse.milo.opcua.sdk.server.nodes

Interface ServerNode

All Superinterfaces:

Node

All Known Implementing Classes:

AcknowledgeableConditionNode, AddressSpaceFileNode, AggregateConfigurationNode, AggregateFunctionNode, AlarmConditionNode, AnalogItemNode, ApplicationCertificateNode, ArrayItemNode, AuditActivateSessionEventNode, AuditAddNodesEventNode, AuditAddReferencesEventNode, AuditCancelEventNode, AuditCertificateDataMismatchEventNode, AuditCertificateEventNode, AuditCertificateExpiredEventNode, AuditCertificateInvalidEventNode, AuditCertificateMismatchEventNode, AuditCertificateRevokedEventNode, AuditCertificateUntrustedEventNode, AuditChannelEventNode, AuditConditionAcknowledgeEventNode, AuditConditionCommentEventNode, AuditConditionConfirmEventNode, AuditConditionEnableEventNode, AuditConditionEventNode, AuditConditionRespondEventNode, AuditConditionShelvingEventNode, AuditCreateSessionEventNode, AuditDeleteNodesEventNode, AuditDeleteReferencesEventNode, AuditEventNode, AuditHistoryAtTimeDeleteEventNode, AuditHistoryDeleteEventNode, AuditHistoryEventDeleteEventNode, AuditHistoryEventUpdateEventNode, AuditHistoryRawModifyDeleteEventNode, AuditHistoryUpdateEventNode, AuditHistoryValueUpdateEventNode, AuditNodeManagementEventNode, AuditOpenSecureChannelEventNode, AuditProgramTransitionEventNode, AuditSecurityEventNode, AuditSessionEventNode, AuditUpdateEventNode, AuditUpdateMethodEventNode, AuditUpdateStateEventNode, AuditUrlMismatchEventNode, AuditWriteUpdateEventNode, BaseConditionClassNode, BaseDataVariableNode, BaseEventNode, BaseModelChangeEventNode, BaseObjectNode, BaseVariableNode, BuildInfoNode, CertificateExpirationAlarmNode, CertificateGroupFolderNode, CertificateGroupNode, CertificateNode, CertificateUpdatedAuditEventNode, ConditionNode, ConditionVariableNode, CubeItemNode, DataItemNode, DataTypeDescriptionNode, DataTypeDictionaryNode, DataTypeEncodingNode, DataTypeSystemNode, DerivedVariableNode, DeviceFailureEventNode, DialogConditionNode, DiscreteAlarmNode, DiscreteItemNode, EventQueueOverflowEventNode, ExclusiveDeviationAlarmNode, ExclusiveLevelAlarmNode, ExclusiveLimitAlarmNode, ExclusiveLimitStateMachineNode, ExclusiveRateOfChangeAlarmNode, FileDirectoryNode, FileNode, FiniteStateMachineNode, FiniteStateVariableNode, FiniteTransitionVariableNode, FolderNode, GeneralModelChangeEventNode, HistoricalDataConfigurationNode, HistoryServerCapabilitiesNode, HttpsCertificateNode, ImageItemNode, InitialStateNode, LimitAlarmNode, MaintenanceConditionClassNode, ModellingRuleNode, MultiStateDiscreteNode, MultiStateValueDiscreteNode, NamespaceMetadataNode, NamespacesNode, NDimensionArrayItemNode, NonExclusiveDeviationAlarmNode, NonExclusiveLevelAlarmNode, NonExclusiveLimitAlarmNode, NonExclusiveRateOfChangeAlarmNode, NonTransparentNetworkRedundancyNode, NonTransparentRedundancyNode, OffNormalAlarmNode, OperationLimitsNode, OptionSetNode, ProcessConditionClassNode, ProgramDiagnosticNode, ProgramStateMachineNode, ProgramTransitionAuditEventNode, ProgramTransitionEventNode, ProgressEventNode, PropertyNode, RefreshEndEventNode, RefreshRequiredEventNode, RefreshStartEventNode, RsaMinApplicationCertificateNode, RsaSha256ApplicationCertificateNode, SamplingIntervalDiagnosticsArrayNode, SamplingIntervalDiagnosticsNode, SemanticChangeEventNode, ServerCapabilitiesNode, ServerConfigurationNode, ServerDiagnosticsNode, ServerDiagnosticsSummaryNode, ServerNode, ServerRedundancyNode, ServerStatusNode, ServerVendorCapabilityNode, SessionDiagnosticsArrayNode, SessionDiagnosticsObjectNode, SessionDiagnosticsVariableNode, SessionsDiagnosticsSummaryNode, SessionSecurityDiagnosticsArrayNode, SessionSecurityDiagnosticsNode, ShelvedStateMachineNode, StateMachineNode, StateNode, StateVariableNode, SubscriptionDiagnosticsArrayNode, SubscriptionDiagnosticsNode, SystemConditionClassNode, SystemEventNode, SystemOffNormalAlarmNode, SystemStatusChangeEventNode, TransitionEventNode, TransitionNode, TransitionVariableNode, TransparentRedundancyNode, TripAlarmNode, TrustListNode, TrustListUpdatedAuditEventNode, TwoStateDiscreteNode, TwoStateVariableNode, UaDataTypeNode, UaFolderNode, UaMethodNode, UaNode, UaObjectNode, UaObjectTypeNode, UaPropertyNode, UaReferenceTypeNode, UaVariableNode, UaVariableTypeNode, UaViewNode, VendorServerInfoNode, XYArrayItemNode, YArrayItemNode

public interface ServerNode
extends Node

Method Summary

Modifier and Type	Method and Description
void	addReference(Reference reference) Add a Reference to this node.
default void	addReferences(Collection<Reference> c) Add References to this node.
DataValue	getAttribute(AttributeContext context, AttributeId attributeId) Get an attribute of this node, taking the AttributeContext into account and respecting any AttributeDelegate this node may have.
com.google.common.collect.ImmutableList<Reference>	getReferences()
default DataValue	readAttribute(AttributeContext context, AttributeId attributeId, TimestampsToReturn timestamps, String indexRange, QualifiedName dataEncoding) Read the specified attribute, applying timestamps and indexRange if specified.
default DataValue	readAttribute(AttributeContext context, UInteger attribute) Read the specified attribute.
default DataValue	readAttribute(AttributeContext context, UInteger attribute, TimestampsToReturn timestamps, String indexRange, QualifiedName dataEncoding) Read the specified attribute.
void	removeReference(Reference reference) Remove a Reference from this node.
default void	removeReferences(Collection<Reference> c) Remove References from this node.
void	setAttribute(AttributeContext context, AttributeId attributeId, DataValue value) Set an attribute of this node, taking the AttributeContext into account and respecting any AttributeDelegate this node may have.
default void	writeAttribute(AttributeContext context, AttributeId attributeId, DataValue value, String indexRange) Write to the specified attribute.
default void	writeAttribute(AttributeContext context, UInteger attribute, DataValue value, String indexRange) Write to the specified attribute.

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

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

Method Detail

addReference

void addReference(Reference reference)

Add a Reference to this node.

Parameters:

reference - the Reference to add.

addReferences

default void addReferences(Collection<Reference> c)

Add References to this node.

Parameters:

c - the References to add.

removeReference

void removeReference(Reference reference)

Remove a Reference from this node.

Parameters:

reference - to remove.

removeReferences

default void removeReferences(Collection<Reference> c)

Remove References from this node.

Parameters:

c - the References to remove.

getReferences

com.google.common.collect.ImmutableList<Reference> getReferences()

Returns:

this node's References.

readAttribute

default DataValue readAttribute(AttributeContext context,
                                UInteger attribute)

Read the specified attribute.

If the attribute is not specified on this node, a value with status StatusCodes.Bad_AttributeIdInvalid will be returned.

Parameters:

attribute - the id of the attribute to read.

Returns:

the value of the specified attribute.

readAttribute

default DataValue readAttribute(AttributeContext context,
                                UInteger attribute,
                                @Nullable
                                TimestampsToReturn timestamps,
                                @Nullable
                                String indexRange,
                                @Nullable
                                QualifiedName dataEncoding)

Read the specified attribute.

If the attribute is not specified on this node, a value with status StatusCodes.Bad_AttributeIdInvalid will be returned.

Parameters:

attribute - the id of the attribute to read.

timestamps - the TimestampsToReturn.

indexRange - the index range to read. Must be a parseable by NumericRange.

dataEncoding - the requested data encoding.

Returns:

the value of the specified attribute.

readAttribute

default DataValue readAttribute(AttributeContext context,
                                AttributeId attributeId,
                                @Nullable
                                TimestampsToReturn timestamps,
                                @Nullable
                                String indexRange,
                                @Nullable
                                QualifiedName dataEncoding)

Read the specified attribute, applying timestamps and indexRange if specified.

If the attribute is not specified on this node, a value with status StatusCodes.Bad_AttributeIdInvalid will be returned.

Parameters:

attributeId - the id of the attribute to read.

timestamps - the TimestampsToReturn.

indexRange - the index range to read. Must be a parseable by NumericRange.

dataEncoding - the requested data encoding.

Returns:

the value of the specified attribute.

writeAttribute

default void writeAttribute(AttributeContext context,
                            UInteger attribute,
                            DataValue value,
                            String indexRange)
                     throws UaException

Write to the specified attribute.

Parameters:

context - the NamespaceManager.

attribute - the id of the attribute to write.

value - the DataValue write.

indexRange - the index range to write. Must be a parseable by NumericRange.

Throws:

UaException - if writing to the attribute fails.

writeAttribute

default void writeAttribute(AttributeContext context,
                            AttributeId attributeId,
                            DataValue value,
                            String indexRange)
                     throws UaException

Write to the specified attribute.

Parameters:

context - the NamespaceManager.

attributeId - the AttributeId of the attribute to write.

value - the DataValue write.

indexRange - the index range to write. Must be a parseable by NumericRange.

Throws:

UaException - if writing to the attribute fails.

getAttribute

DataValue getAttribute(AttributeContext context,
                       AttributeId attributeId)

Get an attribute of this node, taking the AttributeContext into account and respecting any AttributeDelegate this node may have.

Parameters:

context - the AttributeContext to get the attribute in.

attributeId - the AttributeId to get.

Returns:

a DataValue containing the attribute value or a StatusCode describing any failure.

setAttribute

void setAttribute(AttributeContext context,
                  AttributeId attributeId,
                  DataValue value)
           throws UaException

Set an attribute of this node, taking the AttributeContext into account and respecting any AttributeDelegate this node may have.

Parameters:

context - the AttributeContext to set the attribute in.

attributeId - the AttributeId to set.

value - the new DataValue to set for the attribute.

Throws:

UaException - if setting the attribute failed for any reason.