org.eclipse.milo.opcua.sdk.server.namespaces

Class OpcUaNamespace

java.lang.Object

org.eclipse.milo.opcua.sdk.server.namespaces.OpcUaNamespace

All Implemented Interfaces:

AttributeHistoryManager, AttributeManager, MethodServices, MonitoredItemManager, Namespace, NodeManager, ViewManager

public class OpcUaNamespace
extends Object
implements Namespace

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.AttributeManager

AttributeManager.ReadContext, AttributeManager.WriteContext

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.AttributeHistoryManager

AttributeHistoryManager.HistoryReadContext, AttributeHistoryManager.HistoryUpdateContext

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.MethodServices

MethodServices.CallContext

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.NodeManager

NodeManager.AddNodesContext, NodeManager.AddReferencesContext, NodeManager.DeleteNodesContext, NodeManager.DeleteReferencesContext

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.server.api.ViewManager

ViewManager.BrowseContext

Constructor Summary

Constructors

Constructor and Description
OpcUaNamespace(OpcUaServer server)

Method Summary

Modifier and Type	Method and Description
void	addReference(NodeId sourceNodeId, NodeId referenceTypeId, boolean forward, ExpandedNodeId targetNodeId, NodeClass targetNodeClass)
CompletableFuture<List<Reference>>	browse(AccessContext context, NodeId nodeId) If the node identified by nodeId exists return all References.
Optional<MethodInvocationHandler>	getInvocationHandler(NodeId methodId) Get the MethodInvocationHandler for the method identified by methodId, if it exists.
UShort	getNamespaceIndex()
String	getNamespaceUri()
UaObjectNode	getObjectsFolder()
ServerNode	getServerNode()
void	onDataItemsCreated(List<DataItem> dataItems) DataItems have been created for nodes belonging to this NodeManager.
void	onDataItemsDeleted(List<DataItem> dataItems) DataItems have been deleted for nodes belonging to this NodeManager.
void	onDataItemsModified(List<DataItem> dataItems) DataItems have been modified for nodes belonging to this NodeManager.
void	onEventItemsCreated(List<EventItem> eventItems) EventItems have been created for nodes belonging to this NodeManager.
void	onEventItemsDeleted(List<EventItem> eventItems) EventItems have been deleted for nodes belonging to this NodeManager.
void	onEventItemsModified(List<EventItem> eventItems) EventItems have been modified for nodes belonging to this NodeManager.
void	onMonitoringModeChanged(List<MonitoredItem> monitoredItems) MonitoredItems have had their MonitoringMode modified by a client.
void	read(AttributeManager.ReadContext context, Double maxAge, TimestampsToReturn timestamps, List<ReadValueId> readValueIds) Read one or more values from nodes belonging to this AttributeManager.
void	write(AttributeManager.WriteContext context, List<WriteValue> writeValues) Write one or more values to nodes belonging to this AttributeManager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

historyRead, historyUpdate

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

call

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

addNode, addReference, deleteNode, deleteReference

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

browse

Constructor Detail

OpcUaNamespace

public OpcUaNamespace(OpcUaServer server)

Method Detail

getNamespaceIndex

public UShort getNamespaceIndex()

Specified by:

getNamespaceIndex in interface Namespace

Returns:

the index of this Namespace in the server's namespace array.

getNamespaceUri

public String getNamespaceUri()

Specified by:

getNamespaceUri in interface Namespace

Returns:

the URI identifying this Namespace.

browse

public CompletableFuture<List<Reference>> browse(AccessContext context,
                                                 NodeId nodeId)

Description copied from interface: ViewManager

If the node identified by nodeId exists return all References.

The AccessContext can be ignored unless the server wishes to impose some restriction upon which users can browse which nodes. Note that this only obscures what is returned in the browse; nothing prevents a client from addressing a NodeId in other service requests, whether they browsed it or not.

Specified by:

browse in interface ViewManager

Parameters:

context - the AccessContext this request is being made under.

nodeId - the NodeId identifying the node.

Returns:

a CompletableFuture containing the References. If the node is unknown, complete the future exceptionally.

read

public void read(AttributeManager.ReadContext context,
                 Double maxAge,
                 TimestampsToReturn timestamps,
                 List<ReadValueId> readValueIds)

Description copied from interface: AttributeManager

Read one or more values from nodes belonging to this AttributeManager.

Complete the operation with OperationContext.complete(List).

Specified by:

read in interface AttributeManager

Parameters:

context - the AttributeManager.ReadContext.

maxAge - requested max age.

timestamps - requested timestamp values.

readValueIds - the values to read.

write

public void write(AttributeManager.WriteContext context,
                  List<WriteValue> writeValues)

Description copied from interface: AttributeManager

Write one or more values to nodes belonging to this AttributeManager.

Complete the operation with OperationContext.complete(List).

Specified by:

write in interface AttributeManager

Parameters:

context - the AttributeManager.WriteContext.

writeValues - the values to write.

onDataItemsCreated

public void onDataItemsCreated(List<DataItem> dataItems)

Description copied from interface: MonitoredItemManager

DataItems have been created for nodes belonging to this NodeManager.

If sampling is enabled for this item, it is expected that a best-effort will be made to update the item's value at the sampling rate.

Specified by:

onDataItemsCreated in interface MonitoredItemManager

Parameters:

dataItems - the DataItems that were created.

onDataItemsModified

public void onDataItemsModified(List<DataItem> dataItems)

Description copied from interface: MonitoredItemManager

DataItems have been modified for nodes belonging to this NodeManager.

Check to see if the sampling rate has changed or if sampling has been enabled or disabled.

Specified by:

onDataItemsModified in interface MonitoredItemManager

Parameters:

dataItems - the DataItems that were modified.

onDataItemsDeleted

public void onDataItemsDeleted(List<DataItem> dataItems)

Description copied from interface: MonitoredItemManager

DataItems have been deleted for nodes belonging to this NodeManager.

Updates to this item should cease and any references to it should be removed.

Specified by:

onDataItemsDeleted in interface MonitoredItemManager

Parameters:

dataItems - the DataItems that were deleted.

onMonitoringModeChanged

public void onMonitoringModeChanged(List<MonitoredItem> monitoredItems)

Description copied from interface: MonitoredItemManager

MonitoredItems have had their MonitoringMode modified by a client.

Check if sampling is still enabled and react accordingly.

Specified by:

onMonitoringModeChanged in interface MonitoredItemManager

Parameters:

monitoredItems - The MonitoredItems whose MonitoringMode was modified.

onEventItemsCreated

public void onEventItemsCreated(List<EventItem> eventItems)

Description copied from interface: MonitoredItemManager

EventItems have been created for nodes belonging to this NodeManager.

Specified by:

onEventItemsCreated in interface MonitoredItemManager

Parameters:

eventItems - the EventItems that were created.

onEventItemsModified

public void onEventItemsModified(List<EventItem> eventItems)

Description copied from interface: MonitoredItemManager

EventItems have been modified for nodes belonging to this NodeManager.

Specified by:

onEventItemsModified in interface MonitoredItemManager

Parameters:

eventItems - the EventItems that were modified.

onEventItemsDeleted

public void onEventItemsDeleted(List<EventItem> eventItems)

Description copied from interface: MonitoredItemManager

EventItems have been deleted for nodes belonging to this NodeManager.

Specified by:

onEventItemsDeleted in interface MonitoredItemManager

Parameters:

eventItems - the EventItems that were deleted.

addReference

public void addReference(NodeId sourceNodeId,
                         NodeId referenceTypeId,
                         boolean forward,
                         ExpandedNodeId targetNodeId,
                         NodeClass targetNodeClass)
                  throws UaException

Throws:

UaException

getInvocationHandler

public Optional<MethodInvocationHandler> getInvocationHandler(NodeId methodId)

Description copied from interface: MethodServices

Get the MethodInvocationHandler for the method identified by methodId, if it exists.

Specified by:

getInvocationHandler in interface MethodServices

Parameters:

methodId - the NodeId identifying the method.

Returns:

the MethodInvocationHandler for methodId, if it exists.

getObjectsFolder

public UaObjectNode getObjectsFolder()

getServerNode

public ServerNode getServerNode()