org.eclipse.milo.opcua.sdk.server.api

Class AddressSpaceComposite

java.lang.Object

org.eclipse.milo.opcua.sdk.server.api.AddressSpaceComposite

All Implemented Interfaces:

AddressSpace, AddressSpaceFragment, AttributeHistoryServices, AttributeServices, MethodServices, MonitoredItemServices, NodeManagementServices, ViewServices

Direct Known Subclasses:

AddressSpaceManager, ServerNamespace

public class AddressSpaceComposite
extends Object
implements AddressSpaceFragment

An AddressSpace that is composed of AddressSpaceFragments.

Service call operations are executed by the first fragment that matches on the NodeId in the operation.

Nested Class Summary

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

AttributeServices.ReadContext, AttributeServices.WriteContext

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

AttributeHistoryServices.HistoryReadContext, AttributeHistoryServices.HistoryUpdateContext

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

MethodServices.CallContext

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

NodeManagementServices.AddNodesContext, NodeManagementServices.AddReferencesContext, NodeManagementServices.DeleteNodesContext, NodeManagementServices.DeleteReferencesContext

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

ViewServices.BrowseContext, ViewServices.RegisterNodesContext, ViewServices.UnregisterNodesContext

Constructor Summary

Constructors

Constructor and Description
AddressSpaceComposite(OpcUaServer server)

Method Summary

Modifier and Type	Method and Description
void	addNodes(NodeManagementServices.AddNodesContext context, List<AddNodesItem> nodesToAdd)
void	addReferences(NodeManagementServices.AddReferencesContext context, List<AddReferencesItem> referencesToAdd)
void	browse(ViewServices.BrowseContext context, ViewDescription view, NodeId nodeId) Get all References for which nodeId is the source.
void	call(MethodServices.CallContext context, List<CallMethodRequest> requests) Invoke one or more methods belonging to this MethodServices.
void	deleteNodes(NodeManagementServices.DeleteNodesContext context, List<DeleteNodesItem> nodesToDelete)
void	deleteReferences(NodeManagementServices.DeleteReferencesContext context, List<DeleteReferencesItem> referencesToDelete)
protected List<AddressSpaceFragment>	getAddressSpaces() Get a copy of the current AddressSpace list.
AddressSpaceFilter	getFilter() Get the AddressSpaceFilter for this AddressSpace.
void	getReferences(ViewServices.BrowseContext context, ViewDescription view, NodeId nodeId) References for which nodeId is the source are being collected from all AddressSpace instances.
protected OpcUaServer	getServer() Get the OpcUaServer instance.
UInteger	getViewCount() Get the number of views, if any, managed by this ViewServices implementation.
void	historyRead(AttributeHistoryServices.HistoryReadContext context, HistoryReadDetails details, TimestampsToReturn timestamps, List<HistoryReadValueId> readValueIds) Read history values from nodes belonging to this AttributeHistoryServices.
void	historyUpdate(AttributeHistoryServices.HistoryUpdateContext context, List<HistoryUpdateDetails> updateDetailsList) Update history values in nodes belonging to this AttributeHistoryServices.
void	onCreateDataItem(ReadValueId itemToMonitor, Double requestedSamplingInterval, UInteger requestedQueueSize, BiConsumer<Double,UInteger> revisionCallback) A DataItem is being created for a Node managed by this MonitoredItemServices.
void	onCreateEventItem(ReadValueId itemToMonitor, UInteger requestedQueueSize, Consumer<UInteger> revisionCallback) An EventItem is being created for a Node managed by this MonitoredItemServices.
void	onDataItemsCreated(List<DataItem> dataItems) DataItems have been created for nodes belonging to this MonitoredItemServices.
void	onDataItemsDeleted(List<DataItem> dataItems) DataItems have been deleted for nodes belonging to this MonitoredItemServices.
void	onDataItemsModified(List<DataItem> dataItems) DataItems have been modified for nodes belonging to this MonitoredItemServices.
void	onEventItemsCreated(List<EventItem> eventItems) EventItems have been created for nodes belonging to this MonitoredItemServices.
void	onEventItemsDeleted(List<EventItem> eventItems) EventItems have been deleted for nodes belonging to this MonitoredItemServices.
void	onEventItemsModified(List<EventItem> eventItems) EventItems have been modified for nodes belonging to this MonitoredItemServices.
void	onModifyDataItem(ReadValueId itemToModify, Double requestedSamplingInterval, UInteger requestedQueueSize, BiConsumer<Double,UInteger> revisionCallback) A DataItem is being modified for a Node managed by this MonitoredItemServices.
void	onModifyEventItem(ReadValueId itemToModify, UInteger requestedQueueSize, Consumer<UInteger> revisionCallback) An EventItem is being modified for a Node managed by this MonitoredItemServices.
void	onMonitoringModeChanged(List<MonitoredItem> monitoredItems) MonitoredItems have had their MonitoringMode modified by a client.
void	read(AttributeServices.ReadContext context, Double maxAge, TimestampsToReturn timestamps, List<ReadValueId> readValueIds) Read one or more values from nodes belonging to this AttributeServices.
void	register(AddressSpaceFragment addressSpace) Register an AddressSpace with this composite.
void	registerFirst(AddressSpaceFragment addressSpace) Register an AddressSpace with this composite.
void	registerNodes(ViewServices.RegisterNodesContext context, List<NodeId> nodeIds) Register one or more NodeIds.
void	unregister(AddressSpaceFragment addressSpace) Unregister an AddressSpace with this composite.
void	unregisterNodes(ViewServices.UnregisterNodesContext context, List<NodeId> nodeIds) Unregister one or more previously registered NodeIds.
void	write(AttributeServices.WriteContext context, List<WriteValue> writeValues) Write one or more values to nodes belonging to this AttributeServices.

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.services.ViewServices

browse

Constructor Detail

AddressSpaceComposite

public AddressSpaceComposite(OpcUaServer server)

Method Detail

getFilter

public AddressSpaceFilter getFilter()

Description copied from interface: AddressSpaceFragment

Get the AddressSpaceFilter for this AddressSpace.

Specified by:

getFilter in interface AddressSpaceFragment

Returns:

the AddressSpaceFilter for this AddressSpace.

register

public void register(AddressSpaceFragment addressSpace)

Register an AddressSpace with this composite.

The AddressSpace is inserted at the end of the list.

Parameters:

addressSpace - the AddressSpace to register.

registerFirst

public void registerFirst(AddressSpaceFragment addressSpace)

Register an AddressSpace with this composite.

The AddressSpace is inserted at the front of the list.

Parameters:

addressSpace - the AddressSpace to register.

unregister

public void unregister(AddressSpaceFragment addressSpace)

Unregister an AddressSpace with this composite.

Parameters:

addressSpace - the AddressSpace to unregister.

getServer

protected OpcUaServer getServer()

Get the OpcUaServer instance.

Returns:

the OpcUaServer instance.

getAddressSpaces

protected List<AddressSpaceFragment> getAddressSpaces()

Get a copy of the current AddressSpace list.

Returns:

a copy of the current AddressSpace list.

browse

public void browse(ViewServices.BrowseContext context,
                   ViewDescription view,
                   NodeId nodeId)

Description copied from interface: ViewServices

Get all References for which nodeId is the source.

If a Node instance for nodeId does not exist then AsyncOperationContext.failure(StatusCode) should be invoked with StatusCodes.Bad_NodeIdUnknown.

Specified by:

browse in interface ViewServices

Parameters:

context - the ViewServices.BrowseContext.

view - the ViewDescription.

nodeId - the NodeId to browse.

getReferences

public void getReferences(ViewServices.BrowseContext context,
                          ViewDescription view,
                          NodeId nodeId)

Description copied from interface: ViewServices

References for which nodeId is the source are being collected from all AddressSpace instances. Return any References where nodeId is the source this AddressSpace may have to contribute.

The Node identified by nodeId may be managed by another AddressSpace.

Specified by:

getReferences in interface ViewServices

Parameters:

context - the ViewServices.BrowseContext.

view - the ViewDescription.

nodeId - the NodeId to get references fo.

registerNodes

public void registerNodes(ViewServices.RegisterNodesContext context,
                          List<NodeId> nodeIds)

Description copied from interface: ViewServices

Register one or more NodeIds.

Specified by:

registerNodes in interface ViewServices

Parameters:

context - the ViewServices.RegisterNodesContext.

nodeIds - the NodeIds to register.

unregisterNodes

public void unregisterNodes(ViewServices.UnregisterNodesContext context,
                            List<NodeId> nodeIds)

Description copied from interface: ViewServices

Unregister one or more previously registered NodeIds.

Specified by:

unregisterNodes in interface ViewServices

Parameters:

context - the ViewServices.UnregisterNodesContext.

nodeIds - the NodeIds to unregister.

getViewCount

public UInteger getViewCount()

Description copied from interface: ViewServices

Get the number of views, if any, managed by this ViewServices implementation.

Specified by:

getViewCount in interface ViewServices

Returns:

the number of views, if any, managed by this ViewServices implementation.

read

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

Description copied from interface: AttributeServices

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

Complete the operation with AsyncOperationContext.success(Object).

Specified by:

read in interface AttributeServices

Parameters:

context - the AttributeServices.ReadContext.

maxAge - requested max age.

timestamps - requested timestamp values.

readValueIds - the values to read.

write

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

Description copied from interface: AttributeServices

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

Complete the operation with AsyncOperationContext.success(Object).

Specified by:

write in interface AttributeServices

Parameters:

context - the AttributeServices.WriteContext.

writeValues - the values to write.

historyRead

public void historyRead(AttributeHistoryServices.HistoryReadContext context,
                        HistoryReadDetails details,
                        TimestampsToReturn timestamps,
                        List<HistoryReadValueId> readValueIds)

Description copied from interface: AttributeHistoryServices

Read history values from nodes belonging to this AttributeHistoryServices.

Complete the operation with AsyncOperationContext.success(Object).

Specified by:

historyRead in interface AttributeHistoryServices

Parameters:

context - the AttributeHistoryServices.HistoryReadContext.

timestamps - requested timestamp values.

readValueIds - the values to read.

historyUpdate

public void historyUpdate(AttributeHistoryServices.HistoryUpdateContext context,
                          List<HistoryUpdateDetails> updateDetailsList)

Description copied from interface: AttributeHistoryServices

Update history values in nodes belonging to this AttributeHistoryServices.

Complete the operation with AsyncOperationContext.success(Object).

Specified by:

historyUpdate in interface AttributeHistoryServices

Parameters:

context - the AttributeHistoryServices.HistoryUpdateContext.

updateDetailsList - the values to read.

call

public void call(MethodServices.CallContext context,
                 List<CallMethodRequest> requests)

Description copied from interface: MethodServices

Invoke one or more methods belonging to this MethodServices.

Specified by:

call in interface MethodServices

Parameters:

context - the MethodServices.CallContext.

requests - The CallMethodRequests for the methods to invoke.

onCreateDataItem

public void onCreateDataItem(ReadValueId itemToMonitor,
                             Double requestedSamplingInterval,
                             UInteger requestedQueueSize,
                             BiConsumer<Double,UInteger> revisionCallback)

Description copied from interface: MonitoredItemServices

A DataItem is being created for a Node managed by this MonitoredItemServices.

This is a chance to revise the requested queue size and/or sampling interval.

The sampling interval has already been revised to fit within the configured server limits and to be at least the value of the Minimum Sampling Interval attribute for the Node if it was present.

Specified by:

onCreateDataItem in interface MonitoredItemServices

Parameters:

itemToMonitor - the item that will be monitored.

requestedSamplingInterval - the requested sampling interval.

requestedQueueSize - the requested queue size.

revisionCallback - the callback to invoke to revise the sampling interval and queue size.

onModifyDataItem

public void onModifyDataItem(ReadValueId itemToModify,
                             Double requestedSamplingInterval,
                             UInteger requestedQueueSize,
                             BiConsumer<Double,UInteger> revisionCallback)

Description copied from interface: MonitoredItemServices

A DataItem is being modified for a Node managed by this MonitoredItemServices.

This is a chance to revise the requested queue size and/or sampling interval.

The sampling interval has already been revised to fit within the configured server limits and to be at least the value of the Minimum Sampling Interval attribute for the Node if it was present.

Specified by:

onModifyDataItem in interface MonitoredItemServices

Parameters:

itemToModify - the item that will be modified.

requestedSamplingInterval - the requested sampling interval.

requestedQueueSize - the requested queue size.

revisionCallback - the callback to invoke to revise the sampling interval and queue size.

onCreateEventItem

public void onCreateEventItem(ReadValueId itemToMonitor,
                              UInteger requestedQueueSize,
                              Consumer<UInteger> revisionCallback)

Description copied from interface: MonitoredItemServices

An EventItem is being created for a Node managed by this MonitoredItemServices.

This is a chance to revise the requested queue size.

Specified by:

onCreateEventItem in interface MonitoredItemServices

Parameters:

itemToMonitor - the item that will be monitored.

requestedQueueSize - the requested queue size.

revisionCallback - the callback to invoke to revise the queue size.

onModifyEventItem

public void onModifyEventItem(ReadValueId itemToModify,
                              UInteger requestedQueueSize,
                              Consumer<UInteger> revisionCallback)

Description copied from interface: MonitoredItemServices

An EventItem is being modified for a Node managed by this MonitoredItemServices.

This is a chance to revise the requested queue size.

Specified by:

onModifyEventItem in interface MonitoredItemServices

Parameters:

itemToModify - the item that will be modified.

requestedQueueSize - the requested queue size.

revisionCallback - the callback to invoke to revise the queue size.

onDataItemsCreated

public void onDataItemsCreated(List<DataItem> dataItems)

Description copied from interface: MonitoredItemServices

DataItems have been created for nodes belonging to this MonitoredItemServices.

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 MonitoredItemServices

Parameters:

dataItems - the DataItems that were created.

onDataItemsModified

public void onDataItemsModified(List<DataItem> dataItems)

Description copied from interface: MonitoredItemServices

DataItems have been modified for nodes belonging to this MonitoredItemServices.

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

Specified by:

onDataItemsModified in interface MonitoredItemServices

Parameters:

dataItems - the DataItems that were modified.

onDataItemsDeleted

public void onDataItemsDeleted(List<DataItem> dataItems)

Description copied from interface: MonitoredItemServices

DataItems have been deleted for nodes belonging to this MonitoredItemServices.

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

Specified by:

onDataItemsDeleted in interface MonitoredItemServices

Parameters:

dataItems - the DataItems that were deleted.

onEventItemsCreated

public void onEventItemsCreated(List<EventItem> eventItems)

Description copied from interface: MonitoredItemServices

EventItems have been created for nodes belonging to this MonitoredItemServices.

Specified by:

onEventItemsCreated in interface MonitoredItemServices

Parameters:

eventItems - the EventItems that were created.

onEventItemsModified

public void onEventItemsModified(List<EventItem> eventItems)

Description copied from interface: MonitoredItemServices

EventItems have been modified for nodes belonging to this MonitoredItemServices.

Specified by:

onEventItemsModified in interface MonitoredItemServices

Parameters:

eventItems - the EventItems that were modified.

onEventItemsDeleted

public void onEventItemsDeleted(List<EventItem> eventItems)

Description copied from interface: MonitoredItemServices

EventItems have been deleted for nodes belonging to this MonitoredItemServices.

Specified by:

onEventItemsDeleted in interface MonitoredItemServices

Parameters:

eventItems - the EventItems that were deleted.

onMonitoringModeChanged

public void onMonitoringModeChanged(List<MonitoredItem> monitoredItems)

Description copied from interface: MonitoredItemServices

MonitoredItems have had their MonitoringMode modified by a client.

Check if sampling is still enabled and react accordingly.

Specified by:

onMonitoringModeChanged in interface MonitoredItemServices

Parameters:

monitoredItems - The MonitoredItems whose MonitoringMode was modified.

addNodes

public void addNodes(NodeManagementServices.AddNodesContext context,
                     List<AddNodesItem> nodesToAdd)

Specified by:

addNodes in interface NodeManagementServices

deleteNodes

public void deleteNodes(NodeManagementServices.DeleteNodesContext context,
                        List<DeleteNodesItem> nodesToDelete)

Specified by:

deleteNodes in interface NodeManagementServices

addReferences

public void addReferences(NodeManagementServices.AddReferencesContext context,
                          List<AddReferencesItem> referencesToAdd)

Specified by:

addReferences in interface NodeManagementServices

deleteReferences

public void deleteReferences(NodeManagementServices.DeleteReferencesContext context,
                             List<DeleteReferencesItem> referencesToDelete)

Specified by:

deleteReferences in interface NodeManagementServices